org.cloudgraph.config

Class UserDefinedRowKeyFieldConfig

java.lang.Object

org.cloudgraph.config.KeyFieldConfig

org.cloudgraph.config.UserDefinedRowKeyFieldConfig

public class UserDefinedRowKeyFieldConfig
extends KeyFieldConfig

Encapsulates logic related to access of a configured user-defined row 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
UserDefinedRowKeyFieldConfig(DataGraphConfig dataGraph, UserDefinedField userDefinedField, int sequenceNum, int totalFields)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
org.plasma.sdo.DataFlavor	getDataFlavor()
DataGraphConfig	getDataGraph()
org.plasma.sdo.PlasmaProperty	getEndpointProperty()
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 user defined key value from the given data object.
byte[]	getKeyBytes(commonj.sdo.DataGraph dataGraph) Returns a token value from the given Data Graph
byte[]	getKeyBytes(commonj.sdo.DataObject dataObject) Returns a user defined key value from the given data object.
int	getMaxLength() Returns the maximum length allowed for this key field.
String	getPathExpression()
String	getPropertyPath()
int	getSequenceNum()
UserDefinedField	getUserToken()
boolean	isHash()

Methods inherited from class org.cloudgraph.config.KeyFieldConfig

getSeqNum, getTotalFields

Methods inherited from class java.lang.Object

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

Constructor Detail

UserDefinedRowKeyFieldConfig

public UserDefinedRowKeyFieldConfig(DataGraphConfig dataGraph,
                                    UserDefinedField userDefinedField,
                                    int sequenceNum,
                                    int totalFields)

Method Detail

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

getSequenceNum

public int getSequenceNum()

getDataGraph

public DataGraphConfig getDataGraph()

getUserToken

public UserDefinedField getUserToken()

getPathExpression

public String getPathExpression()

isHash

public boolean isHash()

Overrides:

isHash in class KeyFieldConfig

getPropertyPath

public String getPropertyPath()

getEndpointProperty

public org.plasma.sdo.PlasmaProperty getEndpointProperty()

getKeyBytes

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

Returns a token value from the given Data Graph

Specified by:

getKeyBytes in class KeyFieldConfig

Parameters:

dataGraph - the data graph

Returns:

the token value

getKeyBytes

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

Returns a user defined key value from the given data object.

Specified by:

getKeyBytes in class KeyFieldConfig

Parameters:

dataObject - the root data object

Returns:

the token value

Throws:

UnresolvedPathExpressionException - if the configured XPath expression resolves to a null value

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)

Returns a user defined key value from the given data object.

Specified by:

getKey in class KeyFieldConfig

Parameters:

dataObject - the root data object

Returns:

the token value

Throws:

UnresolvedPathExpressionException - if the configured XPath expression resolves to a null value

getMaxLength

public int getMaxLength()

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