org.cloudgraph.store.mapping

Class KeyFieldMapping

java.lang.Object

org.cloudgraph.store.mapping.KeyFieldMapping

Direct Known Subclasses:

ConstantRowKeyFieldMapping, DataRowKeyFieldMapping, MetaKeyFieldMapping

public abstract class KeyFieldMapping
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
static Charset	CHARSET
protected DataGraphMapping	dataGraph
protected KeyFieldCodec	keyFieldCodec
protected int	sequenceNum
protected int	totalFields the total number of fields in the row or column composite key

Constructor Summary

Constructors

Constructor and Description
KeyFieldMapping(DataGraphMapping dataGraph, KeyField field, int sequenceNum, int totalFields)

Method Summary

Modifier and Type	Method and Description
KeyFieldCodec	getCodec() Returns the specified key field codec for the field.
KeyFieldCodecType	getCodecType()
abstract org.plasma.sdo.DataFlavor	getDataFlavor()
abstract org.plasma.sdo.DataType	getDataType()
abstract Object	getKey(commonj.sdo.DataGraph dataGraph) Returns a key value as string from the given data graph
abstract Object	getKey(commonj.sdo.DataObject dataObject) Returns a key value as string from the given data object
abstract Object	getKey(org.plasma.sdo.PlasmaType type) Returns a key value as string from the given type
abstract int	getMaxLength() Returns the maximum length allowed for this key field.
int	getSeqNum()
int	getTotalFields()

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

public static Charset CHARSET

dataGraph

protected DataGraphMapping dataGraph

keyFieldCodec

protected KeyFieldCodec keyFieldCodec

Constructor Detail

KeyFieldMapping

public KeyFieldMapping(DataGraphMapping dataGraph,
                       KeyField field,
                       int sequenceNum,
                       int totalFields)

Method Detail

getSeqNum

public int getSeqNum()

getTotalFields

public int getTotalFields()

getKey

public abstract Object 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 Object 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

getKey

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

Returns a key value as string from the given type

Parameters:

type - the type

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.

getDataType

public abstract org.plasma.sdo.DataType getDataType()

getDataFlavor

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

getCodecType

public KeyFieldCodecType getCodecType()

getCodec

public KeyFieldCodec getCodec()

Returns the specified key field codec for the field.

Returns:

the specified key field codec for the field.