Package com.luciad.ais.model.route

Class TLcdFeaturedRouteSegment

java.lang.Object

com.luciad.ais.model.route.TLcdRouteSegment

com.luciad.ais.model.route.TLcdFeaturedRouteSegment

All Implemented Interfaces:

ILcdEditableRouteSegment, ILcdRouteSegment, ILcdDefaultDisplayNameSettable, ILcdDataObject, ILcdPointList, ILcdFeatured, Serializable, Cloneable

public class TLcdFeaturedRouteSegment
extends TLcdRouteSegment
implements ILcdDefaultDisplayNameSettable

An extension of TLcdRouteSegment with additional properties.

See Also:

• Serialized Form

Field Summary

Fields inherited from class com.luciad.ais.model.route.TLcdRouteSegment

BEGIN_POINT_PROPERTY, END_POINT_PROPERTY, SEQUENCE_NUMBER_PROPERTY

Constructor Summary

Constructors

Constructor	Description
TLcdFeaturedRouteSegment(int aNumberOfFeatures)	Deprecated.
TLcdFeaturedRouteSegment(ILcdRouteSegment aRouteSegment, Object[] aSegmentFeatures)	Deprecated. Use TLcdFeaturedRouteSegment(TLcdFeaturedRouteSegment)
TLcdFeaturedRouteSegment(TLcdFeaturedRouteSegment aRouteSegment)	Creates a new TLcdFeaturedRouteSegment object from a ILcdATSRouteSegment object.
TLcdFeaturedRouteSegment(TLcdDataType aDataType)	Creates a new instance for the given type.

Method Summary

Modifier and Type	Method	Description
boolean	canSetFeature(int aIndex)	Checks whether the specified feature is editable.
String	getDefaultDisplayName()	Returns the String to be used to display the ILcdDefaultDisplayNameSettable object.
int	getDefaultDisplayNameIndex()	Returns the current index of the feature to be uses in the display name.
Object	getFeature(int aIndex)	Returns the feature Object at the given index.
int	getFeatureCount()	Returns the number of features.
Object	getValue(TLcdDataProperty aProperty)	Returns the value of the given property.
void	initializeFeaturedSegment(ILcdRouteSegment aRouteSegment, Object[] aSegmentFeatures)	Copies the values of begin point, end point and sequence number of the ATS route segment aRouteSegment into the begin point, end point and sequence number of this ATS route segment.
void	setDefaultDisplayNameIndex(int aDefaultDisplayNameIndex)	Sets the index of the feature to be used in the display name.
void	setFeature(int aIndex, Object aObject)	Sets the feature Object at the given index.
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.ais.model.route.TLcdRouteSegment

clone, getBeginPoint, getDataType, getEndPoint, getPoint, getPointCount, getSequenceNumber, getValue, hasValue, hasValue, setBeginPoint, setEndPoint, setSequenceNumber, setValue

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.luciad.shape.ILcdPointList

getPointSFCT, getX, getY, getZ

Constructor Details

TLcdFeaturedRouteSegment

@Deprecated
public TLcdFeaturedRouteSegment(int aNumberOfFeatures)

Deprecated.

Creates a new TLcdFeaturedRouteSegment object. The user has to pass on the number of features he wants to store in the new object.

Parameters:

aNumberOfFeatures -

TLcdFeaturedRouteSegment

@Deprecated
public TLcdFeaturedRouteSegment(ILcdRouteSegment aRouteSegment,
 Object[] aSegmentFeatures)

Deprecated.

Use TLcdFeaturedRouteSegment(TLcdFeaturedRouteSegment)

Creates a new TLcdFeaturedRouteSegment object from a ILcdATSRouteSegment object. The new object will contain the same begin and end point and the same sequence number as the given ATS route segment. In addition, it will contain the features specified in the array aSegmentFeatures as well. The data type of the result will be TLcdCoreDataTypes.UNKNOWN_TYPE.

TLcdFeaturedRouteSegment

public TLcdFeaturedRouteSegment(TLcdFeaturedRouteSegment aRouteSegment)

Creates a new TLcdFeaturedRouteSegment object from a ILcdATSRouteSegment object. The new object will contain the same begin and end point and the same sequence number as the given ATS route segment. In addition, it will contain the features specified in the array aSegmentFeatures as well.

TLcdFeaturedRouteSegment

public TLcdFeaturedRouteSegment(TLcdDataType aDataType)

Creates a new instance for the given type.

Parameters:

aDataType - the data type of the returned instance

Throws:

IllegalArgumentException - if TLcdAISDataTypes.RouteSegment is not assignable from the given data type

Since:

10.1

See Also:

• TLcdAISDataTypes.RouteSegment

Method Details

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

Overrides:

getValue in class TLcdRouteSegment

Parameters:

aProperty - the property for which the value is to be returned

Returns:

the value of the given property for this data object

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

Overrides:

setValue in class TLcdRouteSegment

Parameters:

aProperty - the property for which the value is to be set

aValue - the value to set

See Also:

• TLcdDataType.getProperty(String)

initializeFeaturedSegment

public void initializeFeaturedSegment(ILcdRouteSegment aRouteSegment,
 Object[] aSegmentFeatures)

Copies the values of begin point, end point and sequence number of the ATS route segment aRouteSegment into the begin point, end point and sequence number of this ATS route segment. The feature values of this ATS route segment are set to the values found in the array aSegmentFeatures.

getFeature

public Object getFeature(int aIndex)

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.

See Also:

• ILcdFeatured.setFeature(int, java.lang.Object)

setFeature

public void setFeature(int aIndex,
 Object aObject)

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.

aObject - the new feature Object.

See Also:

• ILcdFeatured.getFeature(int)
• ILcdFeatured.canSetFeature(int)

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.

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.

setDefaultDisplayNameIndex

public void setDefaultDisplayNameIndex(int aDefaultDisplayNameIndex)

Description copied from interface: ILcdDefaultDisplayNameSettable

Sets the index of the feature to be used in the display name. The default value is 0.

Specified by:

setDefaultDisplayNameIndex in interface ILcdDefaultDisplayNameSettable

Parameters:

aDefaultDisplayNameIndex - a valid index in the list of features

See Also:

• ILcdDefaultDisplayNameSettable.getDefaultDisplayNameIndex()

getDefaultDisplayNameIndex

public int getDefaultDisplayNameIndex()

Description copied from interface: ILcdDefaultDisplayNameSettable

Returns the current index of the feature to be uses in the display name.

Specified by:

getDefaultDisplayNameIndex in interface ILcdDefaultDisplayNameSettable

Returns:

the current index of the feature to use in the display name

See Also:

• ILcdDefaultDisplayNameSettable.setDefaultDisplayNameIndex(int)

getDefaultDisplayName

public String getDefaultDisplayName()

Description copied from interface: ILcdDefaultDisplayNameSettable

Returns the String to be used to display the ILcdDefaultDisplayNameSettable object.

Specified by:

getDefaultDisplayName in interface ILcdDefaultDisplayNameSettable

Returns:

the String to be used to display the ILcdDefaultDisplayNameSettable object

toString

public String toString()

Overrides:

toString in class Object