Package com.luciad.format.gml31.model

Class TLcdGML31Polygon

java.lang.Object

com.luciad.datamodel.TLcdDataObject

com.luciad.datamodel.TLcdFeaturedDataObject

com.luciad.format.gml31.model.TLcdGML31AbstractGML

com.luciad.format.gml31.model.TLcdGML31AbstractGeometry

com.luciad.format.gml31.model.TLcdGML31AbstractGeometricPrimitive

com.luciad.format.gml31.model.TLcdGML31AbstractSurface

com.luciad.format.gml31.model.TLcdGML31Polygon

All Implemented Interfaces:

ILcdDataObject, ILcdBounded, ILcdEditableSurface, ILcdShape, ILcdSurface, ILcdCloneable, ILcdDeepCloneable, ILcdFeatured, ILcdSelfDescribedFeatured, Serializable, Cloneable

public class TLcdGML31Polygon
extends TLcdGML31AbstractSurface
implements ILcdEditableSurface

A Polygon is a special surface that is defined by a single surface patch (see D.3.6). The boundary of this patch is coplanar and the polygon uses planar interpolation in its interior. The elements exterior and interior describe the surface boundary of the polygon.

Since:

10.0

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final TLcdDataProperty	EXTERIOR_PROPERTY	Data property that maps to the exterior element.
static final TLcdDataProperty	GID_PROPERTY	Property that maps on the gid attribute.
static final TLcdDataProperty	INTERIOR_PROPERTY	Data property that maps to the interior element.

Fields inherited from class com.luciad.format.gml31.model.TLcdGML31AbstractGeometry

SRS_PROPERTY

Fields inherited from class com.luciad.format.gml31.model.TLcdGML31AbstractGML

DESCRIPTION_PROPERTY, ID_PROPERTY, META_DATA_PROPERTY_PROPERTY, NAME_PROPERTY

Constructor Summary

Constructors

Constructor	Description
TLcdGML31Polygon()
TLcdGML31Polygon(TLcdDataType aType)
TLcdGML31Polygon(TLcdDataType aDataType, ILcdModelReference aSrs)	Constructs a polygon and initializes its model reference (srs).
TLcdGML31Polygon(ILcdModelReference aSrs)	Constructs a polygon and initializes its model reference (srs).

Method Summary

Modifier and Type	Method	Description
TLcdGML31Polygon	clone()	Returns a deep clone of this object.
TLcdDataObject	clone(Map aObjectDictionary)	Returns a deep clone of this object.
boolean	contains2D(double aX, double aY)	Checks whether this ILcdShape contains the given point in the 2D space.
boolean	contains2D(ILcdPoint aPoint)	Checks whether this ILcdShape contains the given ILcdPoint in the 2D space.
boolean	contains3D(double aX, double aY, double aZ)	Checks whether this ILcdShape contains the given point in the 3D space.
boolean	contains3D(ILcdPoint aPoint)	Checks whether this ILcdShape contains the given ILcdPoint in the 3D space.
ILcdBounds	getBounds()	Returns the ILcdBounds by which the geometry of this ILcdBounded object is bounded.
TLcdGML31AbstractRing	getExterior()	Returns the role value contained in the value of the EXTERIOR_PROPERTY property.
ILcdRing	getExteriorRing()	Returns the exterior boundary of this surface.
ILcdPoint	getFocusPoint()	Returns the focus point of this ILcdShape.
String	getGid()	Gets the value of the GID_PROPERTY property.
List<TLcdGML31AbstractRing>	getInterior()	Gets the value of the INTERIOR_PROPERTY property adapted to a list of TLcdGML31AbstractRing instances.
List<ILcdRing>	getInteriorRings()	Returns the holes in this surface, as a list of ILcdRing instances.
void	setExterior(TLcdGML31AbstractRing aValue)	Sets the value of the property that maps to the exterior element.
void	setExteriorRing(ILcdRing aExteriorRing)	Sets the exterior boundary of this surface.
void	setGid(String aValue)	Sets the value of the GID_PROPERTY property.

Methods inherited from class com.luciad.format.gml31.model.TLcdGML31AbstractGeometry

getSrs, setSrs, toString

Methods inherited from class com.luciad.format.gml31.model.TLcdGML31AbstractGML

getDescription, getId, getMetaDataProperty, getName, setDescription, setId

Methods inherited from class com.luciad.datamodel.TLcdFeaturedDataObject

canSetFeature, getFeature, getFeature, getFeatureCount, getFeaturedDescriptor, setFeature, setFeature

Methods inherited from class com.luciad.datamodel.TLcdDataObject

getDataType, getValue, getValue, hasValue, hasValue, setValue, setValue

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

EXTERIOR_PROPERTY

public static final TLcdDataProperty EXTERIOR_PROPERTY

Data property that maps to the exterior element. The possible values for this property are instances of TLcdGML31AbstractRingProperty.

INTERIOR_PROPERTY

public static final TLcdDataProperty INTERIOR_PROPERTY

Data property that maps to the interior element. The possible values for this property are instances of List<TLcdGML31AbstractRingProperty>.

GID_PROPERTY

public static final TLcdDataProperty GID_PROPERTY

Property that maps on the gid attribute. Acceptable values for this property are instances of java.lang.String.

Constructor Details

TLcdGML31Polygon

public TLcdGML31Polygon()

TLcdGML31Polygon

public TLcdGML31Polygon(TLcdDataType aType)

TLcdGML31Polygon

public TLcdGML31Polygon(ILcdModelReference aSrs)

Constructs a polygon and initializes its model reference (srs).

Parameters:

aSrs - the model reference for this object

See Also:

• TLcdGML31AbstractGeometry.setSrs(ILcdModelReference)

TLcdGML31Polygon

public TLcdGML31Polygon(TLcdDataType aDataType,
 ILcdModelReference aSrs)

Constructs a polygon and initializes its model reference (srs).

Parameters:

aDataType - the data type for this object

aSrs - the model reference for this object

See Also:

• TLcdGML31AbstractGeometry.setSrs(ILcdModelReference)

Method Details

setExteriorRing

public void setExteriorRing(ILcdRing aExteriorRing)

Description copied from interface: ILcdEditableSurface

Sets the exterior boundary of this surface.

Note that this implementations may throw a ClassCastException or IllegalArgumentException in case the class of the ring is not compatible with the implementation of the surface. Implementations should specify in their documentation all restrictions that apply in this context.

Specified by:

setExteriorRing in interface ILcdEditableSurface

Parameters:

aExteriorRing - the exterior boundary of this surface.

getExteriorRing

public ILcdRing getExteriorRing()

Description copied from interface: ILcdSurface

Returns the exterior boundary of this surface.

Specified by:

getExteriorRing in interface ILcdSurface

Returns:

the exterior boundary of this surface.

getInteriorRings

public List<ILcdRing> getInteriorRings()

Description copied from interface: ILcdEditableSurface

Returns the holes in this surface, as a list of ILcdRing instances. If there are no holes, an empty list is returned.

The returned list is editable and can be used to add, remove or replace interior rings.

Specified by:

getInteriorRings in interface ILcdEditableSurface

Specified by:

getInteriorRings in interface ILcdSurface

Returns:

an editable list containing zero or more rings, representing the holes in this surface.

contains2D

public boolean contains2D(double aX,
 double aY)

Description copied from interface: ILcdShape

Checks whether this ILcdShape contains the given point in the 2D space. Only the first two dimensions of the ILcdShape are considered.

Specified by:

contains2D in interface ILcdShape

Overrides:

contains2D in class TLcdGML31AbstractGeometry

Parameters:

aX - the x coordinate of the point.

aY - the y coordinate of the point.

Returns:

the boolean result of the containment test.

contains3D

public boolean contains3D(double aX,
 double aY,
 double aZ)

Description copied from interface: ILcdShape

Checks whether this ILcdShape contains the given point in the 3D space.

Specified by:

contains3D in interface ILcdShape

Overrides:

contains3D in class TLcdGML31AbstractGeometry

Parameters:

aX - the x coordinate of the point.

aY - the y coordinate of the point.

aZ - the z coordinate of the point.

Returns:

the boolean result of the containment test.

contains2D

public boolean contains2D(ILcdPoint aPoint)

Description copied from interface: ILcdShape

Checks whether this ILcdShape contains the given ILcdPoint in the 2D space. Only the first two dimensions of the ILcdShape and the ILcdPoint are considered.

Specified by:

contains2D in interface ILcdShape

Overrides:

contains2D in class TLcdGML31AbstractGeometry

Parameters:

aPoint - the ILcdPoint to test.

Returns:

the boolean result of the containment test.

See Also:

• ILcdShape.contains2D(double, double)

contains3D

public boolean contains3D(ILcdPoint aPoint)

Description copied from interface: ILcdShape

Checks whether this ILcdShape contains the given ILcdPoint in the 3D space.

Specified by:

contains3D in interface ILcdShape

Overrides:

contains3D in class TLcdGML31AbstractGeometry

Parameters:

aPoint - the ILcdPoint to test.

Returns:

the boolean result of the containment test.

See Also:

• ILcdShape.contains3D(double, double, double)

getFocusPoint

public ILcdPoint getFocusPoint()

Description copied from interface: ILcdShape

Returns the focus point of this ILcdShape.

Specified by:

getFocusPoint in interface ILcdShape

Overrides:

getFocusPoint in class TLcdGML31AbstractGeometry

Returns:

the focus point of this ILcdShape.

getBounds

public ILcdBounds getBounds()

Description copied from interface: ILcdBounded

Returns the ILcdBounds by which the geometry of this ILcdBounded object is bounded.

If the geometry does not allow retrieving valid bounds (for example a polyline with 0 points) the return value is unspecified. It is highly recommended to return an undefined bounds. You can create undefined bounds using the default constructors of TLcdLonLatBounds or TLcdXYBounds.

Specified by:

getBounds in interface ILcdBounded

Overrides:

getBounds in class TLcdGML31AbstractGeometry

Returns:

the ILcdBounds by which the geometry of this ILcdBounded object is bounded.

clone

public TLcdGML31Polygon clone()

Description copied from class: TLcdDataObject

Returns a deep clone of this object. This method delegates to TLcdDataObject.clone(Map).

Specified by:

clone in interface ILcdCloneable

Overrides:

clone in class TLcdDataObject

Returns:

a deep clone of this object

See Also:

• Object.clone()

clone

public TLcdDataObject clone(Map aObjectDictionary)

Description copied from class: TLcdDataObject

Returns a deep clone of this object. If the clone is not already present in the dictionary, a new instance if created as follows:

• First, a new instance is created using Java's clone() mechanism.
• Then, all properties of this object are cloned and set on the newly created instance. A property is cloned as follows:
  • If the property value is an ILcdDataObject, the value is cloned by first creating a new instance via the value.getDataType().newInstance() method, and then cloning its properties one by one.
  • If the value implements ILcdDeepCloneable or ILcdCloneable then this interface is used to clone the value.
  • Otherwise, the property value is copied by reference.

Specified by:

clone in interface ILcdDeepCloneable

Overrides:

clone in class TLcdDataObject

Parameters:

aObjectDictionary - the Object dictionary that keeps track of the objects for which a clone has already been made, and their corresponding clone Object.

Returns:

a deep clone of this object

getExterior

public TLcdGML31AbstractRing getExterior()

Returns the role value contained in the value of the EXTERIOR_PROPERTY property. Returns null if the value of the EXTERIOR_PROPERTY property is null.

A boundary of a surface consists of a number of rings. In the normal 2D case, one of these rings is distinguished as being the exterior boundary. In a general manifold this is not always possible, in which case all boundaries shall be listed as interior boundaries, and the exterior will be empty.

Returns:

the role value of the EXTERIOR_PROPERTY property.

See Also:

• TLcdGML31AbstractRingProperty

setExterior

public void setExterior(TLcdGML31AbstractRing aValue)

Sets the value of the property that maps to the exterior element. to a new instance of the association class TLcdGML31AbstractRingProperty initialized with the given role value. In case the given role value is null, the EXTERIOR_PROPERTY property is set to null.

A boundary of a surface consists of a number of rings. In the normal 2D case, one of these rings is distinguished as being the exterior boundary. In a general manifold this is not always possible, in which case all boundaries shall be listed as interior boundaries, and the exterior will be empty.

Parameters:

aValue - the role value to set for the EXTERIOR_PROPERTY property.

getInterior

public List<TLcdGML31AbstractRing> getInterior()

Gets the value of the INTERIOR_PROPERTY property adapted to a list of TLcdGML31AbstractRing instances.

A boundary of a surface consists of a number of rings. The "interior" rings seperate the surface / surface patch from the area enclosed by the rings.

Returns:

the value of the INTERIOR_PROPERTY property adapted to a list of TLcdGML31AbstractRing instances.

See Also:

• TLcdGML31AbstractRingProperty

getGid

public String getGid()

Gets the value of the GID_PROPERTY property.

This attribute is included for backward compatibility with GML 2 and is deprecated with GML 3. This identifer is superceded by "gml:id" inherited from AbstractGMLType. The attribute "gid" should not be used anymore and may be deleted in future versions of GML without further notice.

Returns:

the value of the GID_PROPERTY property.

setGid

public void setGid(String aValue)

Sets the value of the GID_PROPERTY property.

This attribute is included for backward compatibility with GML 2 and is deprecated with GML 3. This identifer is superceded by "gml:id" inherited from AbstractGMLType. The attribute "gid" should not be used anymore and may be deleted in future versions of GML without further notice.

Parameters:

aValue - the value to set for the GID_PROPERTY property.