com.luciad.format.gdf

Graph and Routing EngineClass TLcdGDFSectionKey

java.lang.Object

com.luciad.format.gdf.TLcdGDFSectionKey

public class TLcdGDFSectionKey
extends Object

Immutable class representing the unique identifier of a section, consisting of the layer key and the section identifier of the section.

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 TLcdGDFSectionKey whose identifiers are identical to the corresponding identifiers of this key, false otherwise.
long	getDatasetIdentifier() Returns the unique identifier of the dataset to which the section belongs.
static TLcdGDFSectionKey	getInstance(long aDatasetIdentifier, long aLayerIdentifier, long aSectionIdentifier) Returns a section key for the given section.
static TLcdGDFSectionKey	getInstance(TLcdGDFLayerKey aLayerKey, long aSectionIdentifier) Returns a section key for the given section.
long	getLayerIdentifier() Returns the unique identifier of the layer to which the section belongs.
TLcdGDFLayerKey	getLayerKey() Returns the layer key of the layer to which this section belongs.
long	getSectionIdentifier() Returns the identifier of the section.
int	hashCode()
String	toString() Returns a general description of this section key.

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static TLcdGDFSectionKey getInstance(long aDatasetIdentifier,
                                            long aLayerIdentifier,
                                            long aSectionIdentifier)

Returns a section key for the given section.

Parameters:

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

aLayerIdentifier - the unique identifier of the layer to which the section belongs.

aSectionIdentifier - the identifier of the section (unique within the layer).

Returns:

a section key with the given dataset identifier and section identifier.

getInstance

public static TLcdGDFSectionKey getInstance(TLcdGDFLayerKey aLayerKey,
                                            long aSectionIdentifier)

Returns a section key for the given section.

Parameters:

aLayerKey - the layer key of the layer to which the section belongs.

aSectionIdentifier - the identifier of the section (unique within the layer).

Returns:

a section key with the given dataset identifier and section identifier.

getLayerKey

public TLcdGDFLayerKey getLayerKey()

Returns the layer key of the layer to which this section belongs.

Returns:

the layer key of the layer to which this section belongs.

getDatasetIdentifier

public long getDatasetIdentifier()

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

Returns:

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

getLayerIdentifier

public long getLayerIdentifier()

Returns the unique identifier of the layer to which the section belongs.

Returns:

the unique identifier of the layer to which the section belongs.

getSectionIdentifier

public long getSectionIdentifier()

Returns the identifier of the section.

Returns:

the identifier of the section.

equals

public boolean equals(Object aObject)

Returns true if the given object is an instance of TLcdGDFSectionKey whose identifiers are identical to the corresponding identifiers 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 section key that identifies exactly the same section as this one, false otherwise.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Returns a general description of this section 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 section key.