Package com.luciad.fusion.platform.model.properties

Class TLfnCustomPropertyDefinitions

java.lang.Object
com.luciad.fusion.platform.model.properties.TLfnCustomPropertyDefinitions
public final class TLfnCustomPropertyDefinitions extends Object
This class contains information about the custom properties definitions. A custom property definition contains information such as the display name and if the property is queryable or not. A queryable property can be used for querying Data.

For each custom property definition, the following information needs to be provided:

  • a name that uniquely identifies the property
  • the type of the property
  • a displayName for the property (optional), suitable for usage in user interfaces
  • whether the property is queryable or not
Based on the type, additional information may need to be provided. For example, a property that is of the Enum type also needs to provide the possible values of the enumeration.

A TLfnCustomPropertyDefinitions instance cannot be created directly. Instead, a builder needs to be used to add information about the properties one by one. 

    TLfnCustomPropertyDefinitions.newBuilder()
                                 .addLongProperty("longProp", "Long Property", true)
                                 .addDoubleProperty("doubleProp", "Double Property", true)
                                 .addStringProperty("stringProp", "String Property", true)
                                 .addBooleanProperty("booleanProp", "Boolean Property", true)
                                 .addDateProperty("dateProp", "Date Property", true)
                                 .addStringProperty("stringEnumProp", "String Enum Property", Set.of("option1", "option2", "option3"), true)
                                 .addLongProperty("longEnumProp", "Long Enum Property", Set.of(200L, 300L, 400L), true)
                                 .build();
The method that is used to add the property information defines the type. For example, use TLfnCustomPropertyDefinitions.Builder.addStringProperty(String) to define a custom property of type string.

An object of this type needs to be provided in the ILfnCustomPropertyDecoder.getPropertyDefinitions().

Since:
2022.1