Class DataType.Builder

java.lang.Object
com.luciad.datamodels.DataType.Builder
All Implemented Interfaces:
AutoCloseable
Enclosing class:
DataType

public static final class DataType.Builder extends Object implements AutoCloseable
Builder that allows DataType instances to be created.

Typical usage would be create a DataType.Builder using DataType#newBuilder, specifying the data type's name. Then add the necessary DataProperty(s) and finally build() the data type. The following snippet shows how this is done for a simple example data type:

    return DataType.newBuilder()
                   .name("TestDataType")
                   .addProperty(TestFeatureModelFactory.SomeProperty)
                   .addProperty(geometryProperty)
                   .addAnnotation(new GeometryDataAnnotationFactory(geometryProperty))
                   .build();
  • Constructor Details

    • Builder

      public Builder(@NotNull DataType.Builder other)
      Copy constructor.
      Parameters:
      other - the builder to copy.
  • Method Details

    • finalize

      protected void finalize()
      Overrides:
      finalize in class Object
    • close

      public void close()
      Specified by:
      close in interface AutoCloseable
    • build

      @NotNull public DataType build() throws IllegalStateException
      Build the data type, including the properties and annotations that were added to this builder.

      After calling this function, this builder should no longer be used.

      Returns:
      the data type.
      Throws:
      IllegalStateException - If not all mandatory parameters are set, or if the data type ends up with more than one GeometryDataAnnotation. A data type has at most one main geometry.
    • addProperty

      @NotNull public DataType.Builder addProperty(@NotNull DataProperty property)
      The property to add to the data type under construction.
      Parameters:
      property - the property to add to the data type under construction.
      Returns:
      this builder.
    • addGeometryProperty

      @NotNull public DataType.Builder addGeometryProperty(@NotNull String name, boolean mainGeometry) throws IllegalStateException
      Adds a property with the given name and DataType#getGeometryType() as its value type, marking it as this type's main geometry when mainGeometry is true.

      If the data type has a single geometry, always pass true. A type needs a main geometry for Feature#findGeometry() and for the default painters to know which property holds the shape to draw. Only a type with several geometry properties needs false, for the ones that are not its main geometry.

      For the main geometry, a GeometryDataAnnotation for the property is wired internally, so there is no need to create that annotation through an IDataAnnotationFactory.

      A data type has at most one main geometry. Calling this again with true throws an exception, and build() additionally rejects a type of which the second GeometryDataAnnotation came from addAnnotation() rather than from here.

      The annotated case is shorthand for adding the property and then attaching its GeometryDataAnnotation through an IDataAnnotationFactory, shown below:

          DataProperty geometryProperty = DataProperty.newBuilder().name("geometry").valueType(DataType.getGeometryType()).build();
          DataType dataType = DataType.newBuilder()
                                      .name("MyType")
                                      .addProperty(geometryProperty)
                                      .addAnnotation(new GeometryDataAnnotationFactory(geometryProperty))
                                      .build();
      
      Parameters:
      name - the name of the geometry property.
      mainGeometry - whether the property is this type's main geometry, annotated with a GeometryDataAnnotation. Pass true unless the data type has more than one geometry property.
      Returns:
      this builder.
      Throws:
      IllegalStateException - if this data type already has a main geometry and mainGeometry is true.
      Since:
      2026.1
    • addIntProperty

      @NotNull public DataType.Builder addIntProperty(@NotNull String name)
      Adds a scalar property with the given name and DataType#getIntType() as its value type.

      Use addProperty() for anything more specific.

      Parameters:
      name - the name of the property.
      Returns:
      this builder.
      Since:
      2026.1
    • addLongProperty

      @NotNull public DataType.Builder addLongProperty(@NotNull String name)
      Adds a scalar property with the given name and DataType#getLongType() as its value type.

      Use addProperty() for anything more specific.

      Parameters:
      name - the name of the property.
      Returns:
      this builder.
      Since:
      2026.1
    • addFloatProperty

      @NotNull public DataType.Builder addFloatProperty(@NotNull String name)
      Adds a scalar property with the given name and DataType#getFloatType() as its value type.

      Use addProperty() for anything more specific.

      Parameters:
      name - the name of the property.
      Returns:
      this builder.
      Since:
      2026.1
    • addDoubleProperty

      @NotNull public DataType.Builder addDoubleProperty(@NotNull String name)
      Adds a scalar property with the given name and DataType#getDoubleType() as its value type.

      Use addProperty() for anything more specific.

      Parameters:
      name - the name of the property.
      Returns:
      this builder.
      Since:
      2026.1
    • addStringProperty

      @NotNull public DataType.Builder addStringProperty(@NotNull String name)
      Adds a scalar property with the given name and DataType#getStringType() as its value type.

      Use addProperty() for anything more specific.

      Parameters:
      name - the name of the property.
      Returns:
      this builder.
      Since:
      2026.1
    • addBooleanProperty

      @NotNull public DataType.Builder addBooleanProperty(@NotNull String name)
      Adds a scalar property with the given name and DataType#getBooleanType() as its value type.

      Use addProperty() for anything more specific.

      Parameters:
      name - the name of the property.
      Returns:
      this builder.
      Since:
      2026.1
    • addAnnotation

      @NotNull public DataType.Builder addAnnotation(@NotNull DataAnnotation annotation) throws NullPointerException
      The annotation to add to the data type under construction.
      Parameters:
      annotation - the annotation to add to the data type under construction.
      Returns:
      this builder.
      Throws:
      NullPointerException - when a null value is passed.
    • addAnnotation

      @NotNull public DataType.Builder addAnnotation(@NotNull IDataAnnotationFactory annotationFactory) throws NullPointerException
      Adds an annotation factory that is invoked when build is called.

      The factory is provided with the type that is being built. This can be useful when the created annotation needs access to the type, for instance when the annotation requires a DataPropertyPath.

      An example usage is:

      class GeometryDataAnnotationFactory(private val property: DataProperty) : IDataAnnotationFactory {
      
          override fun createAnnotation(dataType: DataType): DataAnnotation {
              return GeometryDataAnnotation(
                  DataPropertyPath.newBuilder().originType(dataType).property(property).build()
              )
          }
      }
      

          DataProperty geometryProperty = DataProperty.newBuilder().name("geometry").valueType(DataType.getGeometryType()).build();
          DataType dataType = DataType.newBuilder()
                                      .name("MyType")
                                      .addProperty(geometryProperty)
                                      .addAnnotation(new GeometryDataAnnotationFactory(geometryProperty))
                                      .build();
      
      Parameters:
      annotationFactory - the factory object.
      Returns:
      this builder.
      Throws:
      NullPointerException - when a null value is passed.
    • name

      @NotNull public DataType.Builder name(@NotNull String name)
      The name of the new data type.

      Calling this function is mandatory.

      Parameters:
      name - name of the new data type.
      Returns:
      this builder.