org.cloudgraph.config

Class KeyFieldConfig

java.lang.Object

org.cloudgraph.config.KeyFieldConfig

Direct Known Subclasses:

PreDefinedKeyFieldConfig, UserDefinedRowKeyFieldConfig

public abstract class KeyFieldConfig
extends Object

The configuration for a row or column key.

Since:

0.5.1

Author:

Scott Cinnamond

Field Summary

Fields

Modifier and Type	Field and Description
protected Charset	charset
protected int	sequenceNum
protected int	totalFields the total number of fields in the row or column composite key

Constructor Summary

Constructors

Constructor and Description
KeyFieldConfig(KeyField field, int sequenceNum, int totalFields)

Method Summary

Modifier and Type	Method and Description
abstract org.plasma.sdo.DataFlavor	getDataFlavor()
abstract String	getKey(commonj.sdo.DataGraph dataGraph) Returns a key value as string from the given data graph
abstract String	getKey(commonj.sdo.DataObject dataObject) Returns a key value as string from the given data object
abstract byte[]	getKeyBytes(commonj.sdo.DataGraph dataGraph) Returns a key value as bytes from the given data graph
abstract byte[]	getKeyBytes(commonj.sdo.DataObject dataObject) Returns a key value as bytes from the given data object
abstract int	getMaxLength() Returns the maximum length allowed for this key field.
int	getSeqNum()
int	getTotalFields()
boolean	isHash()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

sequenceNum

protected int sequenceNum

totalFields

protected int totalFields

the total number of fields in the row or column composite key

charset

protected Charset charset

Constructor Detail

KeyFieldConfig

public KeyFieldConfig(KeyField field,
                      int sequenceNum,
                      int totalFields)

Method Detail

getSeqNum

public int getSeqNum()

getTotalFields

public int getTotalFields()

isHash

public boolean isHash()

getKey

public abstract String getKey(commonj.sdo.DataGraph dataGraph)

Returns a key value as string from the given data graph

Parameters:

dataGraph - the data graph

Returns:

the key value

getKey

public abstract String getKey(commonj.sdo.DataObject dataObject)

Returns a key value as string from the given data object

Parameters:

dataObject - the root data object

Returns:

the key value

getKeyBytes

public abstract byte[] getKeyBytes(commonj.sdo.DataGraph dataGraph)

Returns a key value as bytes from the given data graph

Parameters:

dataGraph - the data graph

Returns:

the key value

getKeyBytes

public abstract byte[] getKeyBytes(commonj.sdo.DataObject dataObject)

Returns a key value as bytes from the given data object

Parameters:

dataObject - the root data object

Returns:

the key value

getMaxLength

public abstract int getMaxLength()

Returns the maximum length allowed for this key field.

Returns:

the maximum length allowed for this key field.

getDataFlavor

public abstract org.plasma.sdo.DataFlavor getDataFlavor()