TLcdS57Area (LuciadLightspeed API documentation)

java.lang.Object
- com.luciad.shape.ALcdShape
- - com.luciad.shape.TLcdComplexPolygon
  - - com.luciad.format.s57.TLcdS57Area

All Implemented Interfaces:

ILcdDataObject, ILcdS57FeatureObject, ILcdS57Object, ILcdBounded, ILcdComplexPolygon, ILcdEditableComplexPolygon, ILcdPointList, ILcdShape, ILcdCache, ILcdCloneable, ~~ILcdFeatured~~ , ILcdInvalidateable, Serializable, Cloneable
```
public class TLcdS57Area
extends TLcdComplexPolygon
implements ILcdS57Object, ILcdDataObject, 
ILcdFeatured
, Serializable
```
Represents an Area feature in the S-57 domain model.

See Also:

Serialized Form

Field Summary
- Fields inherited from interface com.luciad.format.s57.ILcdS57FeatureObject
  AREA, LINE, NONE, POINT

Constructor Summary

Constructors
Constructor and Description
`TLcdS57Area(ILcdPolygon[] polygons)` Deprecated. Only TLcdS57Face instances are accepted as polygons. Use the constructor with TLcdS57Face parameter instead.
`TLcdS57Area(TLcdS57FeatureObject aFeatureObject, TLcdS57Face[] aFaces)` Creates a new S-57 Area feature with the specified properties.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`canSetFeature(int aIndex)` Checks whether the specified feature is editable.
`void`	`clearCache()` Clears the cache.
`Object`	`clone()` Creates and returns a copy of this object.
`boolean`	`equals(Object o)` An object is considered equal to this shape if it has the same class.
`TLcdDataType`	`getDataType()` Returns the type of this data object.
`TLcdS57Edge`	`getEdge(int aIndex)` Deprecated. Iterating over the faces and their edges is more performant.
`int`	`getEdgeCount()` Deprecated. Iterating over the faces and their edges is more performant.
`int`	`getEdgeMask(int aIndex)` Returns the mask of the edge that is part of this Area, at the given index.
`int`	`getEdgeOrientation(int aIndex)` Returns the orientation of the edge that is part of this Area, at the given index.
`int`	`getEdgeUsage(int aIndex)` Returns the usage of the edge that is part of this Area, at the given index.
`TLcdS57Face`	`getFace(int aIndex)` Returns the face at `aIndex`.
`int`	`getFaceCount()` Returns the number of faces in this area.
`Object`	`getFeature(int aIndex)` Returns the feature `Object` at the given index.
`int`	`getFeatureCount()` Returns the number of features.
`int`	`getGroup()` Returns the group to which the S-57 object belongs, this can be 1 (= skin of the earth) or 2 (= all other objects).
`ILcdS57Identifier`	`getIdentifier()` Gets the identifier of this shape.
`float`	`getMaximumDepth()` Returns the maximum depth of this area and of containing and intersecting DEPARE and DRGARE objects (only applicable for OBSTRN, UWTROC, and WRECK areas).
`float`	`getMinimumDepth()` Returns the minimum depth of this area and of underlying DEPARE objects (only applicable for DEPARE and DEPCNT areas).
`ILcdPoint`	`getPoint(int aIndex)` Returns the `ILcdPoint` at a given index.
`int`	`getPointCount()` Returns the number of `ILcdPoint` objects in the list.
`ILcdS57Relationship`	`getRelationship(int aIndex)` Returns the relationship at index `aIndex`.
`int`	`getRelationshipCount()` Returns the number of relationships in which this S-57 object is involved.
`int`	`getShape()` Gets the type of the shape: `POINT`, `LINE`, `AREA` or `NONE`.
`Object`	`getValue(String aPropertyName)` Convenience method that returns the value of the property with the given name.
`Object`	`getValue(TLcdDataProperty aProperty)` Returns the value of the given property.
`int`	`hashCode()` The hash code of this shape is the hash code of its class, in order to be consistent with the `ALcdShape.equals(Object)` method.
`boolean`	`hasValue(String aPropertyName)` Indicates whether this data object has a value for the given property.
`boolean`	`hasValue(TLcdDataProperty aProperty)` Indicates whether this data object has a value for the given property.
`void`	`invalidateObject()` Invalidates all cached values of this object.
`void`	`setFeature(int aIndex, Object aFeature)` Sets the feature `Object` at the given index.
`void`	`setGroup(int aGroup)` Sets the group to which the S-57 object belongs, this can be 1 (= skin of the earth) or 2 (= all other objects).
`void`	`setIdentifier(ILcdS57Identifier aIdentifier)` Set the identifier of this object.
`void`	`setMaximumDepth(float aMaximumDepth)` Sets the maximum depth of this area and of containing and intersecting DEPARE and DRGARE objects (only applicable for OBSTRN, UWTROC, and WRECK areas).
`void`	`setMinimumDepth(float aMinimumDepth)` Sets the minimum depth of this area and of underlying DEPARE objects (only applicable for DEPARE and DEPCNT areas).
`void`	`setRelationships(ILcdS57Relationship[] aRelationships)` Sets the relationships in which this S-57 object is involved.
`void`	`setValue(String aPropertyName, Object aValue)` Convenience method that sets the value of the property with the given name.
`void`	`setValue(TLcdDataProperty aProperty, Object aValue)` Sets the value of the given property for this data object.
`String`	`toString()`

Methods inherited from class com.luciad.shape.TLcdComplexPolygon
addPolygon, addPolygon, addPolygons, calculateFocusPoint, clearPolygons, contains2D, contains3D, getBounds, getCachedObject, getFocusPoint, getPolygon, getPolygonCount, getShape, getShapeCount, insertIntoCache, invalidateBounds, polygonChanged, polygonChanged, polygonsChanged, removeCachedObject, removePolygon, removePolygon, removePolygons, setFocusPoint, setPolygon, setPolygon, setPolygons, setShape

Methods inherited from class com.luciad.shape.ALcdShape
contains2D, contains3D, fromDomainObject

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.luciad.shape.ILcdShape
contains2D, contains2D, contains3D, contains3D, getFocusPoint

Methods inherited from interface com.luciad.shape.ILcdBounded
getBounds

Methods inherited from interface com.luciad.shape.ILcdPointList
getPointSFCT, getX, getY, getZ

- Constructor Detail
  - TLcdS57Area
```
public TLcdS57Area(ILcdPolygon[] polygons)
```
    Deprecated. Only TLcdS57Face instances are accepted as polygons. Use the constructor with TLcdS57Face parameter instead.
    
    Creates a new S-57 Area feature with the specified geometry.
    
    Parameters:
    
    polygons - the geometry defining the geographical extent for this Area feature.
  - TLcdS57Area
```
public TLcdS57Area(TLcdS57FeatureObject aFeatureObject,
                   TLcdS57Face[] aFaces)
```
    Creates a new S-57 Area feature with the specified properties.
    
    Parameters:
    
    aFeatureObject - the S-57 feature object describing the object class and attributes of this Area feature.
    
    aFaces - the faces defining the geographical extent of this Area feature.
- Method Detail
  - getFaceCount
```
public int getFaceCount()
```
    Returns the number of faces in this area.
    
    Returns:
    
    the number of faces in this area.
  - getFace
```
public TLcdS57Face getFace(int aIndex)
```
    Returns the face at aIndex.
    
    Parameters:
    
    aIndex - the index of the face to be returned.
    
    Returns:
    
    the face at aIndex.
  - getEdgeCount
```
public int getEdgeCount()
```
    Deprecated. Iterating over the faces and their edges is more performant.
    
    Returns the number of edges this area consists of.
    
    Returns:
    
    the number of edges this area consists of.
  - getEdge
```
public TLcdS57Edge getEdge(int aIndex)
```
    Deprecated. Iterating over the faces and their edges is more performant.
    
    Returns the edge that is part of this area, at the given index.
    
    Parameters:
    
    aIndex - the edge that is part of this area, at the given index.
    
    Returns:
    
    the edge that is part of this area, at the given index.
  - getEdgeOrientation
```
public int getEdgeOrientation(int aIndex)
```
    Returns the orientation of the edge that is part of this Area, at the given index. The orientation indicates in which direction the edge should be traversed to iterate over all points of this Area in forward direction. One of TLcdS57Constants.ORIENTATION_FORWARD or TLcdS57Constants.ORIENTATION_REVERSE.
    
    Parameters:
    
    aIndex - the orientation of the edge that is part of this Area, at the given index.
    
    Returns:
    
    the orientation of the edge at the given index.
  - getEdgeUsage
```
public int getEdgeUsage(int aIndex)
```
    Returns the usage of the edge that is part of this Area, at the given index. The usage indicates whether the edge is part of the outer or inner boundary of an Area. One of TLcdS57Constants.USAGE_EXTERIOR, TLcdS57Constants.USAGE_INTERIOR or TLcdS57Constants.USAGE_EXTERIOR_TRUNCATED.
    
    Parameters:
    
    aIndex - the usage of the edge that is part of this Area, at the given index.
    
    Returns:
    
    the usage of the edge at the given index.
  - getEdgeMask
```
public int getEdgeMask(int aIndex)
```
    Returns the mask of the edge that is part of this Area, at the given index. The mask indicates whether the edge should be rendered or not. In some cases, e.g. for areas which are truncated by cell borders, the edges on the cell border should not be rendered. One of TLcdS57Constants.MASK_MASK, TLcdS57Constants.MASK_SHOW or TLcdS57Constants.MASK_NOT_APPLICABLE.
    
    Parameters:
    
    aIndex - the mask of the edge that is part of this Area, at the given index.
    
    Returns:
    
    the mask of the edge at the given index.
  - setMinimumDepth
```
public void setMinimumDepth(float aMinimumDepth)
```
    Sets the minimum depth of this area and of underlying DEPARE objects (only applicable for DEPARE and DEPCNT areas). The depths are retrieved from the VALSOU and DRVAL1 attributes, if specified. The minimum value can be used as the default depth value (e.g. in the S-52 DEPVAL procedure).
    The minimumDepth property is part of the set of preprocessor variables.
    
    Parameters:
    
    aMinimumDepth - the minimum depth of this area and of underlying DEPARE objects.
    
    See Also:
    
    getMinimumDepth(), TLcdS57Preprocessor
  - getMinimumDepth
```
public float getMinimumDepth()
```
    Returns the minimum depth of this area and of underlying DEPARE objects (only applicable for DEPARE and DEPCNT areas). The depths are retrieved from the VALSOU and DRVAL1 attributes, if specified. The minimum value can be used as the default depth value (e.g. in the S-52 DEPVAL procedure).
    The minimumDepth property is part of the set of preprocessor variables.
    
    Returns:
    
    the minimum depth of this area and of underlying DEPARE objects.
    
    See Also:
    
    setMinimumDepth(float), TLcdS57Preprocessor
  - setMaximumDepth
```
public void setMaximumDepth(float aMaximumDepth)
```
    Sets the maximum depth of this area and of containing and intersecting DEPARE and DRGARE objects (only applicable for OBSTRN, UWTROC, and WRECK areas). The depths are retrieved from the DRVAL1 and DRVAL2 attributes, if specified. The maximum value can be used to determine whether the object is an isolated danger (e.g. in the S-52 UDWHAZ procedure).
    The maximumDepth property is part of the set of preprocessor variables.
    
    Parameters:
    
    aMaximumDepth - the maximum depth of this area and of containing and intersecting DEPARE and DRGARE objects.
    
    See Also:
    
    getMaximumDepth(), TLcdS57Preprocessor
  - getMaximumDepth
```
public float getMaximumDepth()
```
    Returns the maximum depth of this area and of containing and intersecting DEPARE and DRGARE objects (only applicable for OBSTRN, UWTROC, and WRECK areas). The depths are retrieved from the DRVAL1 and DRVAL2 attributes, if specified. The maximum value can be used to determine whether the object is an isolated danger (e.g. in the S-52 UDWHAZ procedure).
    The maximumDepth property is part of the set of preprocessor variables.
    
    Returns:
    
    the maximum depth of this area and of containing and intersecting DEPARE and DRGARE objects.
    
    See Also:
    
    setMaximumDepth(float), TLcdS57Preprocessor
  - setIdentifier
```
public void setIdentifier(ILcdS57Identifier aIdentifier)
```
    Set the identifier of this object.
    
    Parameters:
    
    aIdentifier - the S-57 identifier to be set on this object.
  - setGroup
```
public void setGroup(int aGroup)
```
    Sets the group to which the S-57 object belongs, this can be 1 (= skin of the earth) or 2 (= all other objects).
  - setRelationships
```
public void setRelationships(ILcdS57Relationship[] aRelationships)
```
    Sets the relationships in which this S-57 object is involved. Only relationships in which this object is involved should be included; more formally, for each relationship should hold that
```
relationship.getFirstObject() == this || relationship.getSecondObject() == this
```
    If this object is not involved in any relationship, this method should be called with argument null.
    Parameters:
    
    aRelationships - the array of relationships in which this object is involed.
  - 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.
  - 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:
    
    TLcdDataType.getProperty(String)
  - 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:
    
    TLcdDataType.getProperty(String)
  - 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:
    
    ILcdFeatured.setFeature(int, java.lang.Object)
  - 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:
    
    ILcdFeatured.getFeature(int), ILcdFeatured.canSetFeature(int)
  - clearCache
```
public void clearCache()
```
    Description copied from interface: ILcdCache
    
    Clears the cache.
    
    Specified by:
    
    clearCache in interface ILcdCache
    
    Overrides:
    
    clearCache in class TLcdComplexPolygon
  - invalidateObject
```
public void invalidateObject()
```
    Description copied from interface: ILcdInvalidateable
    
    Invalidates all cached values of this object. Call this method whenever one or more of this object's compositing values has been changed, to notify this object it needs to recompute its cached values.
    
    Specified by:
    
    invalidateObject in interface ILcdInvalidateable
    
    Overrides:
    
    invalidateObject in class TLcdComplexPolygon
  - equals
```
public boolean equals(Object o)
```
    Description copied from class: ALcdShape
    
    An object is considered equal to this shape if it has the same class. Extensions should refine this comparison, based on their properties.
    
    Overrides:
    
    equals in class TLcdComplexPolygon
  - hashCode
```
public int hashCode()
```
    Description copied from class: ALcdShape
    
    The hash code of this shape is the hash code of its class, in order to be consistent with the ALcdShape.equals(Object) method. Extensions should refine this implementation, based on their properties.
    
    Overrides:
    
    hashCode in class TLcdComplexPolygon
  - clone
```
public Object clone()
```
    Description copied from class: TLcdComplexPolygon
    
    Creates and returns a copy of this object.
    The polygon array is deep cloned.
    The cache is not copied or cloned at all.
    
    Specified by:
    
    clone in interface ILcdCloneable
    
    Overrides:
    
    clone in class TLcdComplexPolygon
    
    See Also:
    
    Object.clone()
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getPointCount
```
public int getPointCount()
```
    Description copied from interface: ILcdPointList
    
    Returns the number of ILcdPoint objects in the list.
    
    Specified by:
    
    getPointCount in interface ILcdPointList
    
    Overrides:
    
    getPointCount in class TLcdComplexPolygon
    
    Returns:
    
    the number of ILcdPoint objects in the list.
  - getPoint
```
public ILcdPoint getPoint(int aIndex)
                   throws IndexOutOfBoundsException
```
    Description copied from interface: ILcdPointList
    
    Returns the ILcdPoint at a given index.
    
    Specified by:
    
    getPoint in interface ILcdPointList
    
    Overrides:
    
    getPoint in class TLcdComplexPolygon
    
    Parameters:
    
    aIndex - a valid index in the list of ILcdPoint objects.
    
    Returns:
    
    the ILcdPoint at the given index.
    
    Throws:
    
    IndexOutOfBoundsException - if the given index is out of bounds.

Maritime StandardsClass TLcdS57Area

Field Summary

Fields inherited from interface com.luciad.format.s57.ILcdS57FeatureObject

Constructor Summary

Method Summary

Methods inherited from class com.luciad.shape.TLcdComplexPolygon

Methods inherited from class com.luciad.shape.ALcdShape

Methods inherited from class java.lang.Object

Methods inherited from interface com.luciad.shape.ILcdShape

Methods inherited from interface com.luciad.shape.ILcdBounded

Methods inherited from interface com.luciad.shape.ILcdPointList

Constructor Detail

TLcdS57Area

TLcdS57Area

Method Detail

getFaceCount

getFace

getEdgeCount

getEdge

getEdgeOrientation

getEdgeUsage

getEdgeMask

setMinimumDepth

getMinimumDepth

setMaximumDepth

getMaximumDepth

setIdentifier

setGroup

setRelationships

getIdentifier

getGroup

getShape

getRelationshipCount

getRelationship

getDataType

getValue

getValue

setValue

setValue

hasValue

hasValue

canSetFeature

getFeature

getFeatureCount

setFeature

clearCache

invalidateObject

equals

hashCode

clone

toString

getPointCount

getPoint