Work on Field properties

JohannesJander · JohannesJander · commit a6b9e937bca5 · 2025-03-28T15:54:33.000+01:00
diff --git a/src/main/java/io/frictionlessdata/tableschema/field/AnyField.java b/src/main/java/io/frictionlessdata/tableschema/field/AnyField.java
@@ -19,8 +19,8 @@ public AnyField(String name) {
     }
 
     public AnyField(String name, String format, String title, String description,
-                    URI rdfType, Map<String, Object> constraints, Map<String, Object> options){
-        super(name, FIELD_TYPE_ANY, format, title, description, rdfType, constraints, options);
+                    URI rdfType, Map<String, Object> constraints, Map<String, Object> options, String example){
+        super(name, FIELD_TYPE_ANY, format, title, description, rdfType, constraints, options, example);
     }
 
     @Override
diff --git a/src/main/java/io/frictionlessdata/tableschema/field/ArrayField.java b/src/main/java/io/frictionlessdata/tableschema/field/ArrayField.java
@@ -23,8 +23,8 @@ public ArrayField(String name) {
     }
 
     public ArrayField(String name, String format, String title, String description,
-                      URI rdfType, Map<String, Object> constraints, Map<String, Object> options){
-        super(name, FIELD_TYPE_ARRAY, format, title, description, rdfType, constraints, options);
+                      URI rdfType, Map<String, Object> constraints, Map<String, Object> options, String example){
+        super(name, FIELD_TYPE_ARRAY, format, title, description, rdfType, constraints, options, example);
     }
 
     @Override
diff --git a/src/main/java/io/frictionlessdata/tableschema/field/BooleanField.java b/src/main/java/io/frictionlessdata/tableschema/field/BooleanField.java
@@ -29,8 +29,8 @@ public BooleanField(String name) {
     }
 
     public BooleanField(String name, String format, String title, String description,
-                        URI rdfType, Map<String, Object> constraints, Map<String, Object> options){
-        super(name, FIELD_TYPE_BOOLEAN, format, title, description, rdfType, constraints, options);
+                        URI rdfType, Map<String, Object> constraints, Map<String, Object> options, String example){
+        super(name, FIELD_TYPE_BOOLEAN, format, title, description, rdfType, constraints, options, example);
     }
 
     public void setTrueValues(List<String> newValues) {
diff --git a/src/main/java/io/frictionlessdata/tableschema/field/DateField.java b/src/main/java/io/frictionlessdata/tableschema/field/DateField.java
@@ -26,8 +26,8 @@ public DateField(String name) {
     }
 
     public DateField(String name, String format, String title, String description,
-                     URI rdfType, Map<String, Object> constraints, Map<String, Object> options){
-        super(name, FIELD_TYPE_DATE, format, title, description, rdfType, constraints, options);
+                     URI rdfType, Map<String, Object> constraints, Map<String, Object> options, String example){
+        super(name, FIELD_TYPE_DATE, format, title, description, rdfType, constraints, options, example);
     }
 
     @Override
diff --git a/src/main/java/io/frictionlessdata/tableschema/field/DatetimeField.java b/src/main/java/io/frictionlessdata/tableschema/field/DatetimeField.java
@@ -27,8 +27,8 @@ public DatetimeField(String name) {
     }
 
     public DatetimeField(String name, String format, String title, String description,
-                         URI rdfType, Map<String, Object> constraints, Map<String, Object> options){
-        super(name, FIELD_TYPE_DATETIME, format, title, description, rdfType, constraints, options);
+                         URI rdfType, Map<String, Object> constraints, Map<String, Object> options, String example){
+        super(name, FIELD_TYPE_DATETIME, format, title, description, rdfType, constraints, options, example);
     }
 
     @Override
diff --git a/src/main/java/io/frictionlessdata/tableschema/field/DurationField.java b/src/main/java/io/frictionlessdata/tableschema/field/DurationField.java
@@ -19,8 +19,8 @@ public DurationField(String name) {
     }
 
     public DurationField(String name, String format, String title, String description,
-                         URI rdfType, Map<String, Object> constraints, Map<String, Object> options){
-        super(name, FIELD_TYPE_DURATION, format, title, description, rdfType, constraints, options);
+                         URI rdfType, Map<String, Object> constraints, Map<String, Object> options, String example){
+        super(name, FIELD_TYPE_DURATION, format, title, description, rdfType, constraints, options, example);
     }
 
     @Override
diff --git a/src/main/java/io/frictionlessdata/tableschema/field/Field.java b/src/main/java/io/frictionlessdata/tableschema/field/Field.java
@@ -27,6 +27,7 @@
 @JsonInclude(value = Include.NON_EMPTY)
 @JsonTypeInfo(use = JsonTypeInfo.Id.NAME, defaultImpl = AnyField.class,
         include = JsonTypeInfo.As.EXISTING_PROPERTY, property = "type", visible = true)
+@JsonPropertyOrder({"name", "title", "type", "format", "example", "description", "rdfType", "constraints"})
 @JsonSubTypes({
         @JsonSubTypes.Type(value = StringField.class, name = Field.FIELD_TYPE_STRING),
         @JsonSubTypes.Type(value = IntegerField.class, name = Field.FIELD_TYPE_INTEGER),
@@ -125,6 +126,12 @@ public abstract class Field<T> {
      */
     private String description = null;
 
+    /**
+     * An example value for the field"
+     */
+    private String example = null;
+
+
     /**
      * A field's `type` property is a string indicating the type of this field.
      * http://frictionlessdata.io/specs/table-schema/index.html#field-descriptors
@@ -149,6 +156,7 @@ public abstract class Field<T> {
 
     Map<String, Object> constraints = null;
 
+    @JsonIgnore
     Map<String, Object> options = new HashMap<>();
 
     @JsonAnyGetter
@@ -179,7 +187,8 @@ public Field(
             String description,
             URI rdfType,
             Map<String, Object> constraints,
-            Map<String, Object> options){
+            Map<String, Object> options,
+            String example){
         this.name = name;
         this.type = type;
         this.format = format;
@@ -188,6 +197,7 @@ public Field(
         this.description = description;
         this.constraints = constraints;
         this.options = options;
+        this.example = example;
     }
 
     public static Field<?> fromJson (String json) {
@@ -579,6 +589,14 @@ public void setRdfType(URI rdfType) {
         this.rdfType = rdfType;
     }
 
+    public String getExample() {
+        return example;
+    }
+
+    public void setExample(String example) {
+        this.example = example;
+    }
+
     public Map<String, Object> getOptions() {
         return options;
     }
diff --git a/src/main/java/io/frictionlessdata/tableschema/field/GeojsonField.java b/src/main/java/io/frictionlessdata/tableschema/field/GeojsonField.java
@@ -35,8 +35,8 @@ public GeojsonField(String name) {
     }
 
     public GeojsonField(String name, String format, String title, String description,
-                        URI rdfType, Map<String, Object> constraints, Map<String, Object> options){
-        super(name, FIELD_TYPE_GEOJSON, format, title, description, rdfType, constraints, options);
+                        URI rdfType, Map<String, Object> constraints, Map<String, Object> options, String example){
+        super(name, FIELD_TYPE_GEOJSON, format, title, description, rdfType, constraints, options, example);
     }
 
     @Override
diff --git a/src/main/java/io/frictionlessdata/tableschema/field/GeopointField.java b/src/main/java/io/frictionlessdata/tableschema/field/GeopointField.java
@@ -23,8 +23,8 @@ public GeopointField(String name) {
     }
 
     public GeopointField(String name, String format, String title, String description,
-                         URI rdfType, Map<String, Object> constraints, Map<String, Object> options){
-        super(name, FIELD_TYPE_GEOPOINT, format, title, description, rdfType, constraints, options);
+                         URI rdfType, Map<String, Object> constraints, Map<String, Object> options, String example){
+        super(name, FIELD_TYPE_GEOPOINT, format, title, description, rdfType, constraints, options, example);
     }
 
     @Override
diff --git a/src/main/java/io/frictionlessdata/tableschema/field/IntegerField.java b/src/main/java/io/frictionlessdata/tableschema/field/IntegerField.java
@@ -24,8 +24,8 @@ public IntegerField(String name) {
     }
 
     public IntegerField(String name, String format, String title, String description,
-                        URI rdfType, Map<String, Object> constraints, Map<String, Object> options) {
-        super(name, FIELD_TYPE_INTEGER, format, title, description, rdfType, constraints, options);
+                        URI rdfType, Map<String, Object> constraints, Map<String, Object> options, String example) {
+        super(name, FIELD_TYPE_INTEGER, format, title, description, rdfType, constraints, options, example);
     }
 
     @Override
diff --git a/src/main/java/io/frictionlessdata/tableschema/field/NumberField.java b/src/main/java/io/frictionlessdata/tableschema/field/NumberField.java
@@ -44,8 +44,8 @@ public NumberField(String name) {
     }
 
     public NumberField(String name, String format, String title, String description,
-                       URI rdfType, Map constraints, Map options){
-        super(name, FIELD_TYPE_NUMBER, format, title, description, rdfType, constraints, options);
+                       URI rdfType, Map constraints, Map options, String example){
+        super(name, FIELD_TYPE_NUMBER, format, title, description, rdfType, constraints, options,  example);
     }
 
     @Override
diff --git a/src/main/java/io/frictionlessdata/tableschema/field/ObjectField.java b/src/main/java/io/frictionlessdata/tableschema/field/ObjectField.java
@@ -21,8 +21,8 @@ public ObjectField(String name) {
     }
 
     public ObjectField(String name, String format, String title, String description,
-                       URI rdfType, Map<String, Object> constraints, Map<String, Object> options){
-        super(name, FIELD_TYPE_OBJECT, format, title, description, rdfType, constraints, options);
+                       URI rdfType, Map<String, Object> constraints, Map<String, Object> options, String example){
+        super(name, FIELD_TYPE_OBJECT, format, title, description, rdfType, constraints, options,   example);
     }
 
     @Override
diff --git a/src/main/java/io/frictionlessdata/tableschema/field/StringField.java b/src/main/java/io/frictionlessdata/tableschema/field/StringField.java
@@ -38,8 +38,8 @@ public StringField(String name) {
     }
 
     public StringField(String name, String format, String title, String description,
-                       URI rdfType, Map<String, Object> constraints, Map<String, Object> options){
-        super(name, FIELD_TYPE_STRING, format, title, description, rdfType, constraints, options);
+                       URI rdfType, Map<String, Object> constraints, Map<String, Object> options, String example){
+        super(name, FIELD_TYPE_STRING, format, title, description, rdfType, constraints, options,  example);
     }
 
     @Override
diff --git a/src/main/java/io/frictionlessdata/tableschema/field/TimeField.java b/src/main/java/io/frictionlessdata/tableschema/field/TimeField.java
@@ -24,8 +24,8 @@ public TimeField(String name) {
     }
 
     public TimeField(String name, String format, String title, String description,
-                     URI rdfType, Map<String, Object> constraints, Map<String, Object> options){
-        super(name, FIELD_TYPE_TIME, format, title, description, rdfType, constraints, options);
+                     URI rdfType, Map<String, Object> constraints, Map<String, Object> options, String example){
+        super(name, FIELD_TYPE_TIME, format, title, description, rdfType, constraints, options, example);
     }
 
     @Override
diff --git a/src/main/java/io/frictionlessdata/tableschema/field/YearField.java b/src/main/java/io/frictionlessdata/tableschema/field/YearField.java
@@ -23,8 +23,8 @@ public YearField(String name) {
     }
 
     public YearField(String name, String format, String title, String description,
-                     URI rdfType, Map<String, Object> constraints, Map<String, Object> options){
-        super(name, FIELD_TYPE_YEAR, format, title, description, rdfType, constraints, options);
+                     URI rdfType, Map<String, Object> constraints, Map<String, Object> options, String example){
+        super(name, FIELD_TYPE_YEAR, format, title, description, rdfType, constraints, options, example);
     }
 
     @Override
diff --git a/src/main/java/io/frictionlessdata/tableschema/field/YearmonthField.java b/src/main/java/io/frictionlessdata/tableschema/field/YearmonthField.java
@@ -25,8 +25,8 @@ public YearmonthField(String name) {
     }
 
     public YearmonthField(String name, String format, String title, String description,
-                          URI rdfType, Map<String, Object> constraints, Map<String, Object> options) {
-        super(name, FIELD_TYPE_YEARMONTH, format, title, description, rdfType, constraints, options);
+                          URI rdfType, Map<String, Object> constraints, Map<String, Object> options, String example) {
+        super(name, FIELD_TYPE_YEARMONTH, format, title, description, rdfType, constraints, options, example);
     }
 
     @Override
diff --git a/src/test/java/io/frictionlessdata/tableschema/field/FieldCastTest.java b/src/test/java/io/frictionlessdata/tableschema/field/FieldCastTest.java
@@ -30,23 +30,23 @@ class FieldCastTest {
 
     @Test
     void testFieldCastGeopointDefault() throws Exception{
-        GeopointField field = new GeopointField("test", Field.FIELD_FORMAT_DEFAULT, "title", "description", null, null, null);
+        GeopointField field = new GeopointField("test", Field.FIELD_FORMAT_DEFAULT, "title", "description", null, null, null, null);
         double[] val = field.castValue("0.00012,21");
         Assertions.assertEquals(0.00012, val[0]);
         Assertions.assertEquals(21, val[1]);
     }
 
     @Test
     void testFieldCastGeopointArray() throws Exception{
-        GeopointField field = new GeopointField("test", Field.FIELD_FORMAT_ARRAY, "title", "description", null, null, null);
+        GeopointField field = new GeopointField("test", Field.FIELD_FORMAT_ARRAY, "title", "description", null, null, null, null);
         double[] val = field.castValue("[45,32.54]");
         Assertions.assertEquals(45, val[0]);
         Assertions.assertEquals(32.54, val[1]);
     }
 
     @Test
     void testFieldCastGeopointObject() throws Exception{
-        GeopointField field = new GeopointField("test", Field.FIELD_FORMAT_OBJECT, Field.FIELD_FORMAT_DEFAULT, null, null, null, null);
+        GeopointField field = new GeopointField("test", Field.FIELD_FORMAT_OBJECT, Field.FIELD_FORMAT_DEFAULT, null, null, null, null, null);
         double[] val = field.castValue("{\"lon\": 67.123, \"lat\": 19}");
         Assertions.assertEquals(67.123, val[0]);
         Assertions.assertEquals(19, val[1]);
@@ -68,7 +68,7 @@ void testFieldCastDuration() throws Exception{
 
     @Test
     void testFieldCastValidGeojson() throws Exception{
-        GeojsonField field = new GeojsonField("test", Field.FIELD_FORMAT_DEFAULT, Field.FIELD_FORMAT_DEFAULT, null, null, null, null);
+        GeojsonField field = new GeojsonField("test", Field.FIELD_FORMAT_DEFAULT, Field.FIELD_FORMAT_DEFAULT, null, null, null, null, null);
         JsonNode val = field.castValue("{\n" +
             "    \"type\": \"Feature\",\n" +
             "    \"properties\": {\n" +
@@ -90,7 +90,7 @@ void testFieldCastValidGeojson() throws Exception{
 
     @Test
     void testFieldCastInvalidGeojson() throws Exception{
-        GeojsonField field = new GeojsonField("test", Field.FIELD_FORMAT_DEFAULT, Field.FIELD_FORMAT_DEFAULT, null, null, null, null);
+        GeojsonField field = new GeojsonField("test", Field.FIELD_FORMAT_DEFAULT, Field.FIELD_FORMAT_DEFAULT, null, null, null, null, null);
         assertThrows(InvalidCastException.class, () -> {
             field.castValue("{\n" +
                 "    \"type\": \"INVALID_TYPE\",\n" + // The invalidity is here.
@@ -110,7 +110,7 @@ void testFieldCastInvalidGeojson() throws Exception{
 
     @Test
     void testFieldCastValidTopojson() throws Exception{
-        GeojsonField field = new GeojsonField("test", Field.FIELD_FORMAT_TOPOJSON, Field.FIELD_FORMAT_DEFAULT, null, null, null, null);
+        GeojsonField field = new GeojsonField("test", Field.FIELD_FORMAT_TOPOJSON, Field.FIELD_FORMAT_DEFAULT, null, null, null, null, null);
 
         JsonNode val = field.castValue("{\n" +
             "  \"type\": \"Topology\",\n" +
@@ -157,7 +157,7 @@ void testFieldCastValidTopojson() throws Exception{
 
     @Test
     void testFieldCastInvalidTopojson() throws Exception{
-        GeojsonField field = new GeojsonField("test", Field.FIELD_FORMAT_TOPOJSON, Field.FIELD_FORMAT_DEFAULT, null, null, null, null);
+        GeojsonField field = new GeojsonField("test", Field.FIELD_FORMAT_TOPOJSON, Field.FIELD_FORMAT_DEFAULT, null, null, null, null, null);
 
         // This is an invalid Topojson, it's a Geojson:
         assertThrows(InvalidCastException.class, () -> {
diff --git a/src/test/java/io/frictionlessdata/tableschema/field/FieldConstraintsTest.java b/src/test/java/io/frictionlessdata/tableschema/field/FieldConstraintsTest.java
diff --git a/src/test/java/io/frictionlessdata/tableschema/field/FieldCreationTest.java b/src/test/java/io/frictionlessdata/tableschema/field/FieldCreationTest.java
diff --git a/src/test/java/io/frictionlessdata/tableschema/field/FieldOptionsTest.java b/src/test/java/io/frictionlessdata/tableschema/field/FieldOptionsTest.java
diff --git a/src/test/java/io/frictionlessdata/tableschema/schema/SchemaTest.java b/src/test/java/io/frictionlessdata/tableschema/schema/SchemaTest.java
diff --git a/src/test/java/io/frictionlessdata/tableschema/table_tests/TableIterationTest.java b/src/test/java/io/frictionlessdata/tableschema/table_tests/TableIterationTest.java
diff --git a/src/test/java/io/frictionlessdata/tableschema/table_tests/TableOtherTest.java b/src/test/java/io/frictionlessdata/tableschema/table_tests/TableOtherTest.java
diff --git a/src/test/resources/fixtures/schema/full_schema.json b/src/test/resources/fixtures/schema/full_schema.json

Original file line number	Diff line number	Diff line change
`@@ -19,8 +19,8 @@ public AnyField(String name) {`
`19`	`19`	`}`
`20`	`20`
`21`	`21`	`public AnyField(String name, String format, String title, String description,`
`22`		`- URI rdfType, Map<String, Object> constraints, Map<String, Object> options){`
`23`		`- super(name, FIELD_TYPE_ANY, format, title, description, rdfType, constraints, options);`
	`22`	`+ URI rdfType, Map<String, Object> constraints, Map<String, Object> options, String example){`
	`23`	`+ super(name, FIELD_TYPE_ANY, format, title, description, rdfType, constraints, options, example);`
`24`	`24`	`}`
`25`	`25`
`26`	`26`	`@Override`
Original file line number	Diff line number	Diff line change
`@@ -23,8 +23,8 @@ public ArrayField(String name) {`
`23`	`23`	`}`
`24`	`24`
`25`	`25`	`public ArrayField(String name, String format, String title, String description,`
`26`		`- URI rdfType, Map<String, Object> constraints, Map<String, Object> options){`
`27`		`- super(name, FIELD_TYPE_ARRAY, format, title, description, rdfType, constraints, options);`
	`26`	`+ URI rdfType, Map<String, Object> constraints, Map<String, Object> options, String example){`
	`27`	`+ super(name, FIELD_TYPE_ARRAY, format, title, description, rdfType, constraints, options, example);`
`28`	`28`	`}`
`29`	`29`
`30`	`30`	`@Override`
Original file line number	Diff line number	Diff line change
`@@ -29,8 +29,8 @@ public BooleanField(String name) {`
`29`	`29`	`}`
`30`	`30`
`31`	`31`	`public BooleanField(String name, String format, String title, String description,`
`32`		`- URI rdfType, Map<String, Object> constraints, Map<String, Object> options){`
`33`		`- super(name, FIELD_TYPE_BOOLEAN, format, title, description, rdfType, constraints, options);`
	`32`	`+ URI rdfType, Map<String, Object> constraints, Map<String, Object> options, String example){`
	`33`	`+ super(name, FIELD_TYPE_BOOLEAN, format, title, description, rdfType, constraints, options, example);`
`34`	`34`	`}`
`35`	`35`
`36`	`36`	`public void setTrueValues(List<String> newValues) {`
Original file line number	Diff line number	Diff line change
`@@ -26,8 +26,8 @@ public DateField(String name) {`
`26`	`26`	`}`
`27`	`27`
`28`	`28`	`public DateField(String name, String format, String title, String description,`
`29`		`- URI rdfType, Map<String, Object> constraints, Map<String, Object> options){`
`30`		`- super(name, FIELD_TYPE_DATE, format, title, description, rdfType, constraints, options);`
	`29`	`+ URI rdfType, Map<String, Object> constraints, Map<String, Object> options, String example){`
	`30`	`+ super(name, FIELD_TYPE_DATE, format, title, description, rdfType, constraints, options, example);`
`31`	`31`	`}`
`32`	`32`
`33`	`33`	`@Override`
Original file line number	Diff line number	Diff line change
`@@ -27,8 +27,8 @@ public DatetimeField(String name) {`
`27`	`27`	`}`
`28`	`28`
`29`	`29`	`public DatetimeField(String name, String format, String title, String description,`
`30`		`- URI rdfType, Map<String, Object> constraints, Map<String, Object> options){`
`31`		`- super(name, FIELD_TYPE_DATETIME, format, title, description, rdfType, constraints, options);`
	`30`	`+ URI rdfType, Map<String, Object> constraints, Map<String, Object> options, String example){`
	`31`	`+ super(name, FIELD_TYPE_DATETIME, format, title, description, rdfType, constraints, options, example);`
`32`	`32`	`}`
`33`	`33`
`34`	`34`	`@Override`
Original file line number	Diff line number	Diff line change
`@@ -19,8 +19,8 @@ public DurationField(String name) {`
`19`	`19`	`}`
`20`	`20`
`21`	`21`	`public DurationField(String name, String format, String title, String description,`
`22`		`- URI rdfType, Map<String, Object> constraints, Map<String, Object> options){`
`23`		`- super(name, FIELD_TYPE_DURATION, format, title, description, rdfType, constraints, options);`
	`22`	`+ URI rdfType, Map<String, Object> constraints, Map<String, Object> options, String example){`
	`23`	`+ super(name, FIELD_TYPE_DURATION, format, title, description, rdfType, constraints, options, example);`
`24`	`24`	`}`
`25`	`25`
`26`	`26`	`@Override`
Original file line number	Diff line number	Diff line change
`@@ -35,8 +35,8 @@ public GeojsonField(String name) {`
`35`	`35`	`}`
`36`	`36`
`37`	`37`	`public GeojsonField(String name, String format, String title, String description,`
`38`		`- URI rdfType, Map<String, Object> constraints, Map<String, Object> options){`
`39`		`- super(name, FIELD_TYPE_GEOJSON, format, title, description, rdfType, constraints, options);`
	`38`	`+ URI rdfType, Map<String, Object> constraints, Map<String, Object> options, String example){`
	`39`	`+ super(name, FIELD_TYPE_GEOJSON, format, title, description, rdfType, constraints, options, example);`
`40`	`40`	`}`
`41`	`41`
`42`	`42`	`@Override`
Original file line number	Diff line number	Diff line change
`@@ -23,8 +23,8 @@ public GeopointField(String name) {`
`23`	`23`	`}`
`24`	`24`
`25`	`25`	`public GeopointField(String name, String format, String title, String description,`
`26`		`- URI rdfType, Map<String, Object> constraints, Map<String, Object> options){`
`27`		`- super(name, FIELD_TYPE_GEOPOINT, format, title, description, rdfType, constraints, options);`
	`26`	`+ URI rdfType, Map<String, Object> constraints, Map<String, Object> options, String example){`
	`27`	`+ super(name, FIELD_TYPE_GEOPOINT, format, title, description, rdfType, constraints, options, example);`
`28`	`28`	`}`
`29`	`29`
`30`	`30`	`@Override`
Original file line number	Diff line number	Diff line change
`@@ -24,8 +24,8 @@ public IntegerField(String name) {`
`24`	`24`	`}`
`25`	`25`
`26`	`26`	`public IntegerField(String name, String format, String title, String description,`
`27`		`- URI rdfType, Map<String, Object> constraints, Map<String, Object> options) {`
`28`		`- super(name, FIELD_TYPE_INTEGER, format, title, description, rdfType, constraints, options);`
	`27`	`+ URI rdfType, Map<String, Object> constraints, Map<String, Object> options, String example) {`
	`28`	`+ super(name, FIELD_TYPE_INTEGER, format, title, description, rdfType, constraints, options, example);`
`29`	`29`	`}`
`30`	`30`
`31`	`31`	`@Override`