Skip to content
This repository was archived by the owner on Mar 31, 2025. It is now read-only.

Commit f6934b7

Browse files
committed
Merge remote-tracking branch 'origin/develop' into develop
Conflicts: README.md
2 parents 47dc078 + 9785811 commit f6934b7

1 file changed

Lines changed: 26 additions & 25 deletions

File tree

README.md

Lines changed: 26 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ repositories {
3131

3232
## Initializing
3333

34-
It is required to initialize the Java API before it is used. At leased you have to pss your API-Key to get
34+
It is required to initialize the Java API before it is used. At leased you have to pass your API-Key to get
3535
access to Airtable:
3636

3737
```Java
@@ -41,9 +41,9 @@ Airtable airtable = new Airtable().configure();
4141

4242
### API-Key
4343
The API key could be passed to the app in different ways:
44-
* defining Java property `AIRTABLE_API_KEY` (e.g. `-DAIRTABLE_API_KEY=foo`).
45-
* defining OS environment variable `AIRTABLE_API_KEY` (e.g. `export AIRTABLE_API_KEY=foo`).
46-
* defining property file `credentials.properties` in root classpath containing key/value `AIRTABLE_API_KEY=foo`.
44+
* Defining Java property `AIRTABLE_API_KEY` (e.g. `-DAIRTABLE_API_KEY=foo`).
45+
* Defining OS environment variable `AIRTABLE_API_KEY` (e.g. `export AIRTABLE_API_KEY=foo`).
46+
* Defining property file `credentials.properties` in root classpath containing key/value `AIRTABLE_API_KEY=foo`.
4747
* On the other hand the API-key could also be added by using the method `Airtable.configure(String apiKey)`.
4848

4949
#### How to get API-Key
@@ -68,26 +68,26 @@ The API of Airtable itself is limited to 5 requests per second. If you exceed th
6868
need to wait 30 seconds before subsequent requests will succeed.
6969

7070
### Connecting to Airtable
71-
To use this Libraray you will need a Airtable Object. Simply create one! `Airtable airtable = new Airtable();`.
72-
This Object needs an API-Key or it won't work properly so `airtable.configure(AIRTABLE_API_KEY);`.
73-
Now the Airtable Object needs to know on which base you want access. This Method will return a Base Object which will be used in the Future.
71+
To use this libraray you will need an Airtable object. Simply create one: `Airtable airtable = new Airtable();`.
72+
This object needs an API-Key or it won't work properly so `airtable.configure(AIRTABLE_API_KEY);`.
73+
Now the Airtable object needs to know which base you want to access. This method will return a Base object which will be used in the future:
7474
`Base base = airtable.base(AIRTABLE_BASE);`
7575

76-
With the Base object you can perform all kind of Operations see more [here](#crud-operations-on-table-records).
76+
With the Base object you can perform all kind of operations see more at [CRUD Operations on Table Records](#crud-operations-on-table-records).
7777

7878

7979
## Object Mapping
80-
The Java implementation of the Airtable API provides automatic Object mapping. You can map any Table to your own Java Classes.
81-
But first you need to specify those Classes.
80+
The Java implementation of the Airtable API provides automatic object mapping. You can map any table to your own Java classes.
81+
But first you need to specify those classes.
8282

8383
### Create a Object
84-
The Java Objects represent records or 'values' in Airtable. So the Class attributes need to be adjusted to the Airtable Base.
84+
The Java objects represent records or 'values' in Airtable. So the class attributes need to be adjusted to the Airtable Base.
8585

8686
#### Example
8787

88-
In Aritable we got a Table Actor. The columns represent the Class attributes.
88+
In Airtable we got a table 'Actor'. The columns represent the class attributes.
8989

90-
This is how our Actor Table looks like:
90+
This is how our 'Actor' table looks like:
9191

9292
| Index | Name | Photo | Biography | Filmography |
9393
| :---: | :-----------: | :---------: | :-------: | :--------------------------: |
@@ -96,7 +96,7 @@ This is how our Actor Table looks like:
9696
| 3 | Al Pacino | Some Photos | Long Text | Reference to the Movie Table |
9797
| ... | ... | ... | ... | ... |
9898

99-
Now our Java Class should look like this:
99+
Now our Java class should look like this:
100100
```Java
101101
public class Actor {
102102

@@ -156,9 +156,9 @@ and add Getters and Setters for each attribute. The attribute types can be eithe
156156
`String Array` for references on other Tables or `Attachment` for attached photos and files.
157157

158158

159-
Now we got everything we need to create our first Airtable Table Object.
160-
We use the Java class we just wrote to specify what kind of Object should be saved in our Table. Then we tell our `base`-Object which Table we want to access.
161-
All the Records saved in our Airtable DB now should be in our local Table<JAVA CLASS> Object.
159+
Now we got everything we need to create our first Airtable table object.
160+
We use the Java class we just wrote to specify what kind of Object should be saved in our table. Then we tell our `base`-object which table we want to access.
161+
All the records saved in our Airtable Base now should be in our local Table<JAVA CLASS> Object.
162162

163163
Example:
164164

@@ -171,11 +171,11 @@ Example:
171171
```
172172

173173
### Basic Objects
174-
The Java implementation of the Airtable-API provides an implementation of basic Airtable objects such as attachments and Thumbnails.
174+
The Java implementation of the Airtable-API provides an implementation of basic Airtable objects such as attachments and thumbnails.
175175
Photos and attached files in Airtable are retrieved as `Attachment`s. Photos furthermore contain `Thumbnail`-Objects for different sizes.
176176

177177
#### Attachment
178-
All the `Attachment`-Objects got the following attributes:
178+
All the `Attachment`-objects got the following attributes:
179179

180180
* String `id`
181181
* String `url`
@@ -188,10 +188,10 @@ Photos additionally have:
188188
* Map<String,Thumbnail> `thumbnails`
189189

190190
#### Thumbnails
191-
A Thumbnail is generated for image files in Airtable. Thumbnails are bound to an Attachment Object as a key/value Map.
192-
The Keys are `small` and `large` for the different sizes. The Value is a `Thumbnail`-Object.
191+
A Thumbnail is generated for image files in Airtable. Thumbnails are bound to an `Attachment`-object as a key/value Map.
192+
The keys are `small` and `large` for the different sizes. The value is a `Thumbnail`-object.
193193

194-
A `Thumbnail`-Object got the following Attributes:
194+
A `Thumbnail`-object got the following Attributes:
195195

196196
* String `name`
197197
* String `url`
@@ -202,7 +202,7 @@ Note: The `name` of a Thumbnail Object is identical with it´s key ( `small` or
202202

203203
### Annotations
204204

205-
Use the Java Annotation `@SerializedName` of [Gson](https://github.com/google/gson) to annotate column names containing `-`, empty characters or other not in Java mappable characters.
205+
Use the annotation `@SerializedName` of [Gson](https://github.com/google/gson) to annotate column names containing `-`, empty characters or other not in Java mappable characters.
206206
The airtable.java API will respect these mappings automatically.
207207

208208
#### Example
@@ -215,7 +215,7 @@ The airtable.java API will respect these mappings automatically.
215215
private String name;
216216
```
217217
### Sort
218-
With the integrated Sort element you can retrieve a list of sort objects that specifies how the records will be ordered.
218+
With the integrated `Sort` element you can retrieve a list of sorted objects that specifies how the records will be ordered.
219219
Each sort object must have a field key specifying the name of the field to sort on, and an optional direction key that is either "asc" or "desc".
220220
The default direction is "asc".
221221

@@ -227,7 +227,7 @@ List<Movie> listMovies = movieTable.select(sort);
227227
```
228228
If you set the view parameter, the returned records in that view will be sorted by these fields.
229229

230-
Detailed Example see [TableParameterTest](https://github.com/Sybit-Education/airtable.java/blob/develop/src/test/java/com/sybit/airtable/TableParameterTest.java)
230+
Detailed example see [TableParameterTest](https://github.com/Sybit-Education/airtable.java/blob/develop/src/test/java/com/sybit/airtable/TableParameterTest.java)
231231

232232

233233
## CRUD-Operations on Table Records
@@ -312,6 +312,7 @@ Use `update` to update a record of table:
312312
// detailed Example see TableCreateTest.java
313313

314314
Actor marlonBrando = ...;
315+
315316
marlonBrando.setName("Marlon Brando");
316317
Actor updated = actorTable.update(marlonBrando);
317318
```

0 commit comments

Comments
 (0)