org.cloudgraph.store.mapping

Class DataRowKeyFieldMapping

java.lang.Object

org.cloudgraph.store.mapping.KeyFieldMapping

org.cloudgraph.store.mapping.DataRowKeyFieldMapping

public class DataRowKeyFieldMapping
extends KeyFieldMapping

Encapsulates logic related to access of a configured row key data field.

Since:

0.5.1

Author:

Scott Cinnamond

Field Summary

Fields inherited from class org.cloudgraph.store.mapping.KeyFieldMapping

CHARSET, dataGraph, keyFieldCodec, sequenceNum, totalFields

Constructor Summary

Constructors

Constructor and Description
DataRowKeyFieldMapping(DataGraphMapping dataGraph, DataField dataField, int sequenceNum, int totalFields)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
org.plasma.sdo.DataFlavor	getDataFlavor()
DataGraphMapping	getDataGraph()
org.plasma.sdo.DataType	getDataType()
org.plasma.sdo.PlasmaProperty	getEndpointProperty()
Object	getKey(commonj.sdo.DataGraph dataGraph) Returns a key value as string from the given data graph
Object	getKey(commonj.sdo.DataObject dataObject) Returns a user defined key value from the given data object.
Object	getKey(org.plasma.sdo.PlasmaType type) Returns a key value as string from the given type
int	getMaxLength() Returns the maximum length allowed for this key field.
String	getPathExpression()
String	getPropertyPath()
int	getSequenceNum()
DataField	getUserToken()
String	toString()

Methods inherited from class org.cloudgraph.store.mapping.KeyFieldMapping

getCodec, getCodecType, getSeqNum, getTotalFields

Methods inherited from class java.lang.Object

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

Constructor Detail

DataRowKeyFieldMapping

public DataRowKeyFieldMapping(DataGraphMapping dataGraph,
                              DataField dataField,
                              int sequenceNum,
                              int totalFields)

Method Detail

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

getSequenceNum

public int getSequenceNum()

getDataGraph

public DataGraphMapping getDataGraph()

getUserToken

public DataField getUserToken()

getPathExpression

public String getPathExpression()

getPropertyPath

public String getPropertyPath()

getEndpointProperty

public org.plasma.sdo.PlasmaProperty getEndpointProperty()

getKey

public Object getKey(commonj.sdo.DataGraph dataGraph)

Description copied from class: KeyFieldMapping

Returns a key value as string from the given data graph

Specified by:

getKey in class KeyFieldMapping

Parameters:

dataGraph - the data graph

Returns:

the key value

getKey

public Object getKey(commonj.sdo.DataObject dataObject)

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

Specified by:

getKey in class KeyFieldMapping

Parameters:

dataObject - the root data object

Returns:

the token value

Throws:

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

getKey

public Object getKey(org.plasma.sdo.PlasmaType type)

Description copied from class: KeyFieldMapping

Returns a key value as string from the given type

Specified by:

getKey in class KeyFieldMapping

Parameters:

type - the type

Returns:

the key value

getMaxLength

public int getMaxLength()

Returns the maximum length allowed for this key field.

Specified by:

getMaxLength in class KeyFieldMapping

Returns:

the maximum length allowed for this key field.

getDataType

public org.plasma.sdo.DataType getDataType()

Specified by:

getDataType in class KeyFieldMapping

getDataFlavor

public org.plasma.sdo.DataFlavor getDataFlavor()

Specified by:

getDataFlavor in class KeyFieldMapping

toString

public String toString()

Overrides:

toString in class Object