com.luciad.format.gdf

Graph and Routing EngineClass TLcdGDFDatasetKey

java.lang.Object

com.luciad.format.gdf.TLcdGDFDatasetKey

public class TLcdGDFDatasetKey
extends Object

Immutable class representing the unique identifier of a GDF dataset, consisting of the dataset 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 TLcdGDFDatasetKey whose identifier is identical to the corresponding identifier of this key, false otherwise.
long	getDatasetIdentifier() Returns the unique identifier of the dataset.
static TLcdGDFDatasetKey	getInstance(long aDatasetIdentifier) Returns a dataset key for the given dataset identifier.
int	hashCode()
String	toString() Returns a general description of this dataset key.

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static TLcdGDFDatasetKey getInstance(long aDatasetIdentifier)

Returns a dataset key for the given dataset identifier.

Parameters:

aDatasetIdentifier - the unique identifier of the dataset.

Returns:

a dataset key with the given dataset identifier.

getDatasetIdentifier

public long getDatasetIdentifier()

Returns the unique identifier of the dataset.

Returns:

the unique identifier of the dataset.

equals

public boolean equals(Object aObject)

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

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