com.luciad.format.gdf

Graph and Routing EngineClass TLcdGDFFeatureKey

java.lang.Object

com.luciad.format.gdf.TLcdGDFFeatureKey

public class TLcdGDFFeatureKey
extends Object

Immutable class representing the unique identifier of a feature, consisting of the section key, the feature category and the feature identifier. Note that the feature category is an essential part of the key: two features belonging to the same section but having different feature categories can have the same feature identifier.

Since:

5.1

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object aObject) Returns true if the given object is an instance of TLcdGDFFeatureKey whose identifiers and feature category are identical to the corresponding identifiers and feature category of this key, false otherwise.
long	getDatasetIdentifier() Returns the unique identifier of the dataset to which the feature belongs.
TLcdGDFFeatureCategory	getFeatureCategory() Returns the feature category of the feature.
long	getFeatureIdentifier() Returns the identifier of the feature (unique within the section'samples set of features that have the same feature category).
static TLcdGDFFeatureKey	getInstance(long aDatasetIdentifier, long aLayerIdentifier, long aSectionIdentifier, long aFeatureIdentifier, TLcdGDFFeatureCategory aFeatureCategory) Returns a feature key for the given set of identifiers that define the feature.
static TLcdGDFFeatureKey	getInstance(TLcdGDFSectionKey aSectionKey, long aFeatureIdentifier, TLcdGDFFeatureCategory aFeatureCategory) Returns a feature key for the given feature identifiers.
long	getLayerIdentifier() Returns the unique identifier of the layer to which the feature belongs (unique within the dataset).
long	getSectionIdentifier() Returns the identifier of the section to which the feature belongs (unique within the layer).
TLcdGDFSectionKey	getSectionKey() Returns the section key of the feature.
int	hashCode()
String	toString() Returns a general description of this feature key.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

getInstance

public static TLcdGDFFeatureKey getInstance(long aDatasetIdentifier,
                                            long aLayerIdentifier,
                                            long aSectionIdentifier,
                                            long aFeatureIdentifier,
                                            TLcdGDFFeatureCategory aFeatureCategory)

Returns a feature key for the given set of identifiers that define the feature.

Parameters:

aDatasetIdentifier - the unique identifier of the dataset to which the feature belongs.

aLayerIdentifier - the identifier of the layer to which the feature belongs (unique within the dataset).

aSectionIdentifier - the identifier of the section to which the feature belongs (unique within the layer).

aFeatureIdentifier - the identifier of the feature (unique within the section's set of features that have the same feature category).

aFeatureCategory - the feature category of the feature.

Returns:

a feature key with the given identifier set.

getInstance

public static TLcdGDFFeatureKey getInstance(TLcdGDFSectionKey aSectionKey,
                                            long aFeatureIdentifier,
                                            TLcdGDFFeatureCategory aFeatureCategory)

Returns a feature key for the given feature identifiers.

Parameters:

aSectionKey - the section key of the section to which the feature belongs.

aFeatureIdentifier - the identifier of the feature (unique within the section'samples set of features that have the same feature category).

aFeatureCategory - the feature category of the feature.

Returns:

a feature key with the given identifier set.

getSectionKey

public TLcdGDFSectionKey getSectionKey()

Returns the section key of the feature.

Returns:

the section key of the feature.

getDatasetIdentifier

public long getDatasetIdentifier()

Returns the unique identifier of the dataset to which the feature belongs.

Returns:

the unique identifier of the dataset to which the feature belongs.

getLayerIdentifier

public long getLayerIdentifier()

Returns the unique identifier of the layer to which the feature belongs (unique within the dataset).

Returns:

the unique identifier of the layer to which the feature belongs (unique within the dataset).

getSectionIdentifier

public long getSectionIdentifier()

Returns the identifier of the section to which the feature belongs (unique within the layer).

Returns:

the identifier of the section to which the feature belongs (unique within the layer).

getFeatureIdentifier

public long getFeatureIdentifier()

Returns the identifier of the feature (unique within the section'samples set of features that have the same feature category).

Returns:

the identifier of the feature.

getFeatureCategory

public TLcdGDFFeatureCategory getFeatureCategory()

Returns the feature category of the feature.

Returns:

the feature category of the feature.

equals

public boolean equals(Object aObject)

Returns true if the given object is an instance of TLcdGDFFeatureKey whose identifiers and feature category are identical to the corresponding identifiers and feature category of this key, false otherwise.

Overrides:

equals in class Object

Parameters:

aObject - the object to be compared with.

Returns:

true if the given object is a feature key that identifies exactly the same feature as this one, false otherwise.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Returns a general description of this feature key. The exact details of the representation are unspecified and are subject to change.

Overrides:

toString in class Object

Returns:

a general description of this feature key.