net.sf.basedb.core
Enum FeatureIdentificationMethod

java.lang.Object
  java.lang.Enum<FeatureIdentificationMethod>
      net.sf.basedb.core.FeatureIdentificationMethod

All Implemented Interfaces:

Serializable, Comparable<FeatureIdentificationMethod>

public enum FeatureIdentificationMethod
extends Enum<FeatureIdentificationMethod>

This enumeration defines constants that are used to specify which method to use for identifying features on an array design.

Version:

2.6

Author:

Nicklas

Last modified

$Date: 2009-04-06 14:52:39 +0200 (Mon, 06 Apr 2009) $

Enum Constant Summary

COORDINATES
Use coordinates (block, metaGridX, metaGridY, row, column)

FEATURE_ID
Use the external feature ID.

NONE
None, because the array design is a file-only platform.

POSITION
Use position number.

Field Summary

private boolean	caseInsensitive If the feature identifiers may be affect by case sensitivity at the database level or not.
private String	displayValue Returned by the toString method.
private int	value The integer value of this method.
private static Map<Integer,FeatureIdentificationMethod>	valueMapping Maps an integer to a location.

Method Summary

boolean	caseInsensitive() Return TRUE if this identification method can be case insensitive.
static FeatureIdentificationMethod	fromValue(int value) Get the FeatureIdentificationMethod object when you know the integer code.
(package private) abstract Object	getIdentifier(FeatureData feature) Get the feature identifier for this method.
(package private) abstract Object	getIdentifier(RawData raw, String externalFeatureId) Get a feature identifier using this method
int	getValue() Get the integer value that is used when storing the feature identification method to the database.
String	toString()
static FeatureIdentificationMethod	valueOf(String name) Returns the enum constant of this type with the specified name.
static FeatureIdentificationMethod[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NONE

public static final FeatureIdentificationMethod NONE

None, because the array design is a file-only platform.

COORDINATES

public static final FeatureIdentificationMethod COORDINATES

Use coordinates (block, metaGridX, metaGridY, row, column)

POSITION

public static final FeatureIdentificationMethod POSITION

Use position number.

FEATURE_ID

public static final FeatureIdentificationMethod FEATURE_ID

Use the external feature ID.

Field Detail

valueMapping

private static final Map<Integer,FeatureIdentificationMethod> valueMapping

Maps an integer to a location.

value

private final int value

The integer value of this method.

displayValue

private final String displayValue

Returned by the toString method.

caseInsensitive

private final boolean caseInsensitive

If the feature identifiers may be affect by case sensitivity at the database level or not.

Method Detail

values

public static FeatureIdentificationMethod[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (FeatureIdentificationMethod c : FeatureIdentificationMethod.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static FeatureIdentificationMethod valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

toString

public String toString()

Overrides:

toString in class Enum<FeatureIdentificationMethod>

fromValue

public static FeatureIdentificationMethod fromValue(int value)

Get the FeatureIdentificationMethod object when you know the integer code.

Parameters:

value - The integer value.

Returns:

The feature identification method for the integer value.

getValue

public int getValue()

Get the integer value that is used when storing the feature identification method to the database.

Returns:

The integer value for this method.

caseInsensitive

public boolean caseInsensitive()

Return TRUE if this identification method can be case insensitive. Ie. because the identifier is a string object. In this case we must check if the database is case sensitive or not. If FALSE, case is not in issue, ie. because the identifier is not a string object.

See Also:

DbEngine.caseInsensitiveComparison()

getIdentifier

abstract Object getIdentifier(FeatureData feature)

Get the feature identifier for this method.

Parameters:

feature - The feature to get the identifier for

getIdentifier

abstract Object getIdentifier(RawData raw,
                              String externalFeatureId)

Get a feature identifier using this method

Parameters:

raw - The raw data to pick coordinates/position from

externalFeatureId - The external feature ID, null can be used if not needed by this particular identification method