Package com.luciad.format.s57

Class TLcdS57FeatureObject

java.lang.Object
com.luciad.format.s57.TLcdS57FeatureObject
All Implemented Interfaces:
ILcdDataObject, ILcdS57FeatureObject, ILcdCloneable, ILcdFeatured, Serializable, Cloneable
public class TLcdS57FeatureObject extends Object implements ILcdDataObject, ILcdFeatured, ILcdCloneable
Default implementation of ILcdS57FeatureObject.

The ILcdDataObject interface is only supported if the ILcdS57Identifier identifier that is configured on this object is an instance of TLcdS57Identifier (the ILcdS57Identifier interface does not provide access to the object class descriptor and data type of the S-57 object class, only the concrete class TLcdS57Identifier does). In case the interface is not supported, the data type of this object will be TLcdUnknownDataTypes.UNKNOWN_TYPE, and it will have no properties.

See Also:

  • Constructor Details

    • TLcdS57FeatureObject

      public TLcdS57FeatureObject()

  • Method Details

    • getDataType

      public TLcdDataType getDataType()
      Description copied from interface: ILcdDataObject
      Returns the type of this data object. This can never be null.
      Specified by:
      getDataType in interface ILcdDataObject
      Returns:
      the type of this data object

    • getValue

      public Object getValue(TLcdDataProperty aProperty)
      Description copied from interface: ILcdDataObject

      Returns the value of the given property.

      If the property is a collection, the returned value will never be null. If the property has not been set, an empty collection of the appropriate type will be returned (Set, List or Map).

      The property must not be null, and must be declared in the data object's type or in one of its super types. Otherwise an IllegalArgumentException is thrown.

      Specified by:
      getValue in interface ILcdDataObject
      Parameters:
      aProperty - the property for which the value is to be returned
      Returns:
      the value of the given property for this data object

    • getValue

      public Object getValue(String aPropertyName)
      Description copied from interface: ILcdDataObject

      Convenience method that returns the value of the property with the given name.

      If more than one property exists with the given name, the most specific property should be used (this is the property defined by the most specialized type in this object's data type hierarchy).

      See ILcdDataObject.getValue(TLcdDataProperty) for more information.

      Specified by:
      getValue in interface ILcdDataObject
      Parameters:
      aPropertyName - the name of the property of which the value is to be returned
      Returns:
      the value of the property with the given name
      See Also:

    • setValue

      public void setValue(TLcdDataProperty aProperty, Object aValue)
      Description copied from interface: ILcdDataObject

      Sets the value of the given property for this data object. The implementation is allowed to throw an exception if the given value can't be set.

      The given property must be declared in the data object's type or in one of its super types. In other words, getDataType().getProperties().contains( aProperty ) should always be true. Otherwise, the implementation should throw an IllegalArgumentException.

      Specified by:
      setValue in interface ILcdDataObject
      Parameters:
      aProperty - the property for which the value is to be set
      aValue - the value to set
      See Also:

    • setValue

      public void setValue(String aPropertyName, Object aValue)
      Description copied from interface: ILcdDataObject

      Convenience method that sets the value of the property with the given name.

      If more than one property exists with the given name, the most specific property should be used (this is the property defined by the most specialized type in this object's data type hierarchy).

      See ILcdDataObject.setValue(TLcdDataProperty, Object) for more information.

      Specified by:
      setValue in interface ILcdDataObject
      Parameters:
      aPropertyName - the name of the property of which the value is to be set
      aValue - the value to set

    • hasValue

      public boolean hasValue(TLcdDataProperty aProperty)
      Description copied from interface: ILcdDataObject
      Indicates whether this data object has a value for the given property.

      • aProperty is from the right data type, and this instance has a value for it: returns true
      • aProperty is from the right data type, and this instance has no value for it: returns false
      • aProperty is not from the right data type: not allowed, you will get IllegalArgumentException
      • aProperty is null: not allowed, you will get NullPointerException

      A multivalued property is considered to have a value if it has at least one value.

      Specified by:
      hasValue in interface ILcdDataObject
      Parameters:
      aProperty - the property for which to return whether a value is present or not.
      Returns:
      true if this data object has a value for the given property, false otherwise.

    • hasValue

      public boolean hasValue(String aPropertyName)
      Description copied from interface: ILcdDataObject
      Indicates whether this data object has a value for the given property.
      See ILcdDataObject.hasValue(TLcdDataProperty) for more information.
      Specified by:
      hasValue in interface ILcdDataObject
      Parameters:
      aPropertyName - the name of the property for which to return whether a value is present or not.
      Returns:
      true if this data object has a value for the property with the given name, false otherwise.

    • canSetFeature

      public boolean canSetFeature(int aIndex)
      Description copied from interface: ILcdFeatured
      Checks whether the specified feature is editable.
      Specified by:
      canSetFeature in interface ILcdFeatured
      Parameters:
      aIndex - a valid feature index.
      Returns:
      true if the feature can be set, false otherwise.

    • getFeature

      public Object getFeature(int aIndex) throws IndexOutOfBoundsException
      Description copied from interface: ILcdFeatured
      Returns the feature Object at the given index.
      Specified by:
      getFeature in interface ILcdFeatured
      Parameters:
      aIndex - a valid feature index.
      Returns:
      the feature Object at the given index.
      Throws:
      IndexOutOfBoundsException - when an index is chosen greater than the result of getFeatureCount.
      See Also:

    • getFeatureCount

      public int getFeatureCount()
      Description copied from interface: ILcdFeatured
      Returns the number of features.
      Specified by:
      getFeatureCount in interface ILcdFeatured
      Returns:
      the number of features.

    • setFeature

      public void setFeature(int aIndex, Object aFeature) throws IllegalArgumentException
      Description copied from interface: ILcdFeatured
      Sets the feature Object at the given index.
      Specified by:
      setFeature in interface ILcdFeatured
      Parameters:
      aIndex - a valid feature index.
      aFeature - the new feature Object.
      Throws:
      IllegalArgumentException - if the feature can't be set.
      See Also:

    • setIdentifier

      public void setIdentifier(ILcdS57Identifier aIdentifier)

    • setGroup

      public void setGroup(int aGroup)

    • setRelationships

      public void setRelationships(ILcdS57Relationship[] aRelationships)

    • getIdentifier

      public ILcdS57Identifier getIdentifier()
      Description copied from interface: ILcdS57FeatureObject
      Gets the identifier of this shape.
      Specified by:
      getIdentifier in interface ILcdS57FeatureObject

    • getGroup

      public int getGroup()
      Description copied from interface: ILcdS57FeatureObject
      Returns the group to which the S-57 object belongs, this can be 1 (= skin of the earth) or 2 (= all other objects).
      Specified by:
      getGroup in interface ILcdS57FeatureObject
      Returns:
      the group to which the S-57 object belongs

    • getShape

      public int getShape()
      Description copied from interface: ILcdS57FeatureObject
      Gets the type of the shape: POINT, LINE, AREA or NONE.
      Specified by:
      getShape in interface ILcdS57FeatureObject

    • getRelationshipCount

      public int getRelationshipCount()
      Description copied from interface: ILcdS57FeatureObject
      Returns the number of relationships in which this S-57 object is involved.
      Specified by:
      getRelationshipCount in interface ILcdS57FeatureObject
      Returns:
      the number of relationships in which this S-57 object is involved.

    • getRelationship

      public ILcdS57Relationship getRelationship(int aIndex)
      Description copied from interface: ILcdS57FeatureObject
      Returns the relationship at index aIndex.
      Specified by:
      getRelationship in interface ILcdS57FeatureObject
      Parameters:
      aIndex - index of the relationship to return
      Returns:
      the relationship at the specified position.

    • clone

      public Object clone()
      Description copied from interface: ILcdCloneable

      Makes Object.clone() public.

      When for example extending from java.lang.Object, it can be implemented like this: 
      
 public Object clone() {
   try {
     return super.clone();
   } catch ( CloneNotSupportedException e ) {
     // Cannot happen: extends from Object and implements Cloneable (see also Object.clone)
     throw new RuntimeException( e );
   }
 }
      Specified by:
      clone in interface ILcdCloneable
      Overrides:
      clone in class Object
      See Also:

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object