org.cloudgraph.config

Class PreDefinedKeyFieldConfig

java.lang.Object

org.cloudgraph.config.KeyFieldConfig

org.cloudgraph.config.PreDefinedKeyFieldConfig

Direct Known Subclasses:

ColumnKeyFieldConfig

public class PreDefinedKeyFieldConfig
extends KeyFieldConfig

Encapsulates logic related to access of a configured pre-defined row or column key field.

Since:

0.5.1

Author:

Scott Cinnamond

Field Summary

Fields inherited from class org.cloudgraph.config.KeyFieldConfig

charset, sequenceNum, totalFields

Constructor Summary

Constructors

Constructor and Description
PreDefinedKeyFieldConfig(PredefinedField field, int seqNum, int totalFields)

Method Summary

Modifier and Type	Method and Description
org.plasma.sdo.DataFlavor	getDataFlavor()
PredefinedField	getField()
String	getKey(commonj.sdo.DataGraph dataGraph) Returns a key value as string from the given data graph
String	getKey(commonj.sdo.DataObject dataObject) Returns a key value as string from the given data object
byte[]	getKeyBytes(commonj.sdo.DataGraph dataGraph) Returns a key value from the given Data Graph
byte[]	getKeyBytes(commonj.sdo.DataObject dataObject) Returns a key value from the given data object
byte[]	getKeyBytes(EdgeMetaKey metaField)
byte[]	getKeyBytes(EntityMetaKey metaField)
byte[]	getKeyBytes(org.plasma.sdo.PlasmaProperty property) Returns a key value from the given type
byte[]	getKeyBytes(org.plasma.sdo.PlasmaType type) Returns a key value from the given type
byte[]	getKeyBytes(org.plasma.sdo.PlasmaType type, EdgeMetaKey metaField)
byte[]	getKeyBytes(org.plasma.sdo.PlasmaType type, EntityMetaKey metaField)
byte[]	getKeyBytes(org.plasma.sdo.PlasmaType type, org.plasma.sdo.PlasmaProperty property) Returns a key value from the given type
int	getMaxLength() Returns the maximum length allowed for this key field.
PreDefinedFieldName	getName()
boolean	isHash()

Methods inherited from class org.cloudgraph.config.KeyFieldConfig

getSeqNum, getTotalFields

Methods inherited from class java.lang.Object

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

Constructor Detail

PreDefinedKeyFieldConfig

public PreDefinedKeyFieldConfig(PredefinedField field,
                                int seqNum,
                                int totalFields)

Method Detail

getField

public PredefinedField getField()

getName

public PreDefinedFieldName getName()

isHash

public boolean isHash()

Overrides:

isHash in class KeyFieldConfig

getKey

public String getKey(commonj.sdo.DataGraph dataGraph)

Description copied from class: KeyFieldConfig

Returns a key value as string from the given data graph

Specified by:

getKey in class KeyFieldConfig

Parameters:

dataGraph - the data graph

Returns:

the key value

getKey

public String getKey(commonj.sdo.DataObject dataObject)

Description copied from class: KeyFieldConfig

Returns a key value as string from the given data object

Specified by:

getKey in class KeyFieldConfig

Parameters:

dataObject - the root data object

Returns:

the key value

getKeyBytes

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

Returns a key value from the given Data Graph

Specified by:

getKeyBytes in class KeyFieldConfig

Parameters:

dataGraph - the data graph

Returns:

the key value

getKeyBytes

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

Returns a key value from the given data object

Specified by:

getKeyBytes in class KeyFieldConfig

Parameters:

dataObject - the root data object

Returns:

the key value

getKeyBytes

public byte[] getKeyBytes(org.plasma.sdo.PlasmaType type,
                          org.plasma.sdo.PlasmaProperty property)

Returns a key value from the given type

Parameters:

type - the type

Returns:

the key value

getKeyBytes

public byte[] getKeyBytes(org.plasma.sdo.PlasmaType type,
                          EntityMetaKey metaField)

getKeyBytes

public byte[] getKeyBytes(org.plasma.sdo.PlasmaType type,
                          EdgeMetaKey metaField)

getKeyBytes

public byte[] getKeyBytes(org.plasma.sdo.PlasmaType type)

Returns a key value from the given type

Parameters:

type - the type

Returns:

the key value

getKeyBytes

public byte[] getKeyBytes(org.plasma.sdo.PlasmaProperty property)

Returns a key value from the given type

Parameters:

type - the type

Returns:

the key value

getKeyBytes

public byte[] getKeyBytes(EntityMetaKey metaField)

getKeyBytes

public byte[] getKeyBytes(EdgeMetaKey metaField)

getMaxLength

public int getMaxLength()

Description copied from class: KeyFieldConfig

Returns the maximum length allowed for this key field.

Specified by:

getMaxLength in class KeyFieldConfig

Returns:

the maximum length allowed for this key field.

getDataFlavor

public org.plasma.sdo.DataFlavor getDataFlavor()

Specified by:

getDataFlavor in class KeyFieldConfig