org.cloudgraph.store.mapping

Class MetaKeyFieldMapping

java.lang.Object

org.cloudgraph.store.mapping.KeyFieldMapping

org.cloudgraph.store.mapping.MetaKeyFieldMapping

Direct Known Subclasses:

ColumnKeyFieldMapping

public class MetaKeyFieldMapping
extends KeyFieldMapping

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.store.mapping.KeyFieldMapping

CHARSET, dataGraph, keyFieldCodec, sequenceNum, totalFields

Constructor Summary

Constructors

Constructor and Description
MetaKeyFieldMapping(DataGraphMapping dataGraph, MetaField field, int seqNum, int totalFields)

Method Summary

Modifier and Type	Method and Description
org.plasma.sdo.DataFlavor	getDataFlavor()
org.plasma.sdo.DataType	getDataType()
MetaField	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
Object	getKey(org.plasma.sdo.PlasmaType type) Returns a key value from the given type
byte[]	getKeyBytes(commonj.sdo.DataGraph dataGraph) Deprecated.
byte[]	getKeyBytes(commonj.sdo.DataObject dataObject) Deprecated.
byte[]	getKeyBytes(EdgeMetaKey metaField)
byte[]	getKeyBytes(EntityMetaKey metaField)
byte[]	getKeyBytes(org.plasma.sdo.PlasmaProperty property) Deprecated.
byte[]	getKeyBytes(org.plasma.sdo.PlasmaType type) Deprecated.
byte[]	getKeyBytes(org.plasma.sdo.PlasmaType type, EdgeMetaKey metaField) Deprecated.
byte[]	getKeyBytes(org.plasma.sdo.PlasmaType type, EntityMetaKey metaField) Deprecated.
byte[]	getKeyBytes(org.plasma.sdo.PlasmaType type, org.plasma.sdo.PlasmaProperty property) Deprecated.
int	getMaxLength() Returns the maximum length allowed for this key field.
MetaFieldName	getName()
String	toString()

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

getCodec, getCodecType, getSeqNum, getTotalFields

Methods inherited from class java.lang.Object

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

Constructor Detail

MetaKeyFieldMapping

public MetaKeyFieldMapping(DataGraphMapping dataGraph,
                           MetaField field,
                           int seqNum,
                           int totalFields)

Method Detail

getField

public MetaField getField()

getName

public MetaFieldName getName()

getKey

public String 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 String getKey(commonj.sdo.DataObject dataObject)

Description copied from class: KeyFieldMapping

Returns a key value as string from the given data object

Specified by:

getKey in class KeyFieldMapping

Parameters:

dataObject - the root data object

Returns:

the key value

getKeyBytes

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

Deprecated.

Returns a key value from the given Data Graph

Parameters:

dataGraph - the data graph

Returns:

the key value

getKeyBytes

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

Deprecated.

Returns a key value from the given data object

Parameters:

dataObject - the root data object

Returns:

the key value

getKeyBytes

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

Deprecated.

Returns a key value from the given type

Parameters:

type - the type

Returns:

the key value

getKeyBytes

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

Deprecated.

getKeyBytes

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

Deprecated.

getKeyBytes

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

Deprecated.

Returns a key value from the given type

Parameters:

type - the type

Returns:

the key value

getKey

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

Returns a key value from the given type

Specified by:

getKey in class KeyFieldMapping

Parameters:

type - the type

Returns:

the key value

getKeyBytes

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

Deprecated.

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: KeyFieldMapping

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