Package com.luciad.format.aixm51.model.features.notes

Class TLcdAIXM51Note

java.lang.Object
com.luciad.datamodel.TLcdDataObject
com.luciad.format.gml32.model.TLcdGML32AbstractGML
com.luciad.format.aixm51.model.abstractfeature.TLcdAIXM51AbstractAIXMObject
com.luciad.format.aixm51.model.features.notes.TLcdAIXM51Note
All Implemented Interfaces:
ILcdDataObject, ILcdCloneable, ILcdDeepCloneable, Cloneable
public class TLcdAIXM51Note extends TLcdAIXM51AbstractAIXMObject
A general text note for a feature or for one of its properties.
Since:
10.0

  • Field Details

    • PROPERTY_NAME_PROPERTY

      public static final TLcdDataProperty PROPERTY_NAME_PROPERTY
      Data property that maps to the propertyName element. The possible values for this property are instances of TLcdAIXM51Optional<String>.

    • PURPOSE_PROPERTY

      public static final TLcdDataProperty PURPOSE_PROPERTY
      Data property that maps to the purpose element. The possible values for this property are instances of TLcdAIXM51Optional<TLcdAIXM51CodeNotePurpose>.

    • TRANSLATED_NOTE_PROPERTY

      public static final TLcdDataProperty TRANSLATED_NOTE_PROPERTY
      Data property that maps to the translatedNote element. The possible values for this property are instances of List<TLcdAIXM51Property<TLcdAIXM51LinguisticNote>>.

    • EXTENSION_PROPERTY

      public static final TLcdDataProperty EXTENSION_PROPERTY
      Data property that maps to the extension element. The possible values for this property are instances of List<TLcdAIXM51Link<TLcdAIXM51AbstractExtension>>.

  • Constructor Details

    • TLcdAIXM51Note

      public TLcdAIXM51Note()

    • TLcdAIXM51Note

      public TLcdAIXM51Note(TLcdDataType aType)

  • Method Details

    • getPropertyName

      public String getPropertyName()
      Returns the role value contained in the value of the PROPERTY_NAME_PROPERTY property. Returns null if the value of the PROPERTY_NAME_PROPERTY property is null.

      The name of the feature property for which this note is relevant, if applicable. If no propertyName is specified, then the Note is relevant for the feature as a whole.

      Returns:
      the role value of the PROPERTY_NAME_PROPERTY property.
      See Also:

    • setPropertyName

      public void setPropertyName(String aValue)
      Sets the value of the property that maps to the propertyName element. to a new instance of the association class TLcdAIXM51Optional initialized with the given role value. In case the given role value is null, the PROPERTY_NAME_PROPERTY property is set to null.

      The name of the feature property for which this note is relevant, if applicable. If no propertyName is specified, then the Note is relevant for the feature as a whole.

      Parameters:
      aValue - the role value to set for the PROPERTY_NAME_PROPERTY property.

    • getPurpose

      public TLcdAIXM51CodeNotePurpose getPurpose()
      Returns the role value contained in the value of the PURPOSE_PROPERTY property. Returns null if the value of the PURPOSE_PROPERTY property is null.

      An indication of the goal which led to the provision of the free text note.

      Returns:
      the role value of the PURPOSE_PROPERTY property.
      See Also:

    • setPurpose

      public void setPurpose(TLcdAIXM51CodeNotePurpose aValue)
      Sets the value of the property that maps to the purpose element. to a new instance of the association class TLcdAIXM51Optional initialized with the given role value. In case the given role value is null, the PURPOSE_PROPERTY property is set to null.

      An indication of the goal which led to the provision of the free text note.

      Parameters:
      aValue - the role value to set for the PURPOSE_PROPERTY property.

    • getTranslatedNote

      public List<TLcdAIXM51LinguisticNote> getTranslatedNote()
      Gets the value of the TRANSLATED_NOTE_PROPERTY property adapted to a list of TLcdAIXM51LinguisticNote instances.

      The Note written linguistically.

      Returns:
      the value of the TRANSLATED_NOTE_PROPERTY property adapted to a list of TLcdAIXM51LinguisticNote instances.
      See Also:

    • getExtension

      public List<TLcdAIXM51AbstractExtension> getExtension()
      Gets the value of the EXTENSION_PROPERTY property adapted to a list of TLcdAIXM51AbstractExtension instances.
      Returns:
      the value of the EXTENSION_PROPERTY property adapted to a list of TLcdAIXM51AbstractExtension instances.
      See Also: