com.luciad.format.gdf

Graph and Routing EngineClass TLcdGDFLayerKey

java.lang.Object

com.luciad.format.gdf.TLcdGDFLayerKey

public class TLcdGDFLayerKey
extends Object

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

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 TLcdGDFLayerKey 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 layer belongs.
TLcdGDFDatasetKey	getDatasetKey() Returns the dataset key of the dataset to which this layer belongs.
static TLcdGDFLayerKey	getInstance(long aDatasetIdentifier, long aLayerIdentifier) Returns a layer key for the given layer.
long	getLayerIdentifier() Returns the identifier of the layer.
int	hashCode()
String	toString() Returns a general description of this layer key.

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static TLcdGDFLayerKey getInstance(long aDatasetIdentifier,
                                          long aLayerIdentifier)

Returns a layer key for the given layer.

Parameters:

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

aLayerIdentifier - the identifier of the layer (unique within the dataset).

Returns:

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

getDatasetKey

public TLcdGDFDatasetKey getDatasetKey()

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

Returns:

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

getDatasetIdentifier

public long getDatasetIdentifier()

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

Returns:

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

getLayerIdentifier

public long getLayerIdentifier()

Returns the identifier of the layer.

Returns:

the identifier of the layer.

equals

public boolean equals(Object aObject)

Returns true if the given object is an instance of TLcdGDFLayerKey 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 layer key that identifies exactly the same layer as this one, false otherwise.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

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