org.cloudgraph.store.mapping

Class StoreMapping

java.lang.Object

org.cloudgraph.store.mapping.StoreMapping

All Implemented Interfaces:

MappingConfiguration

public class StoreMapping
extends Object
implements MappingConfiguration

Configuration mapping marshaling and un-marshaling with data access convenience methods. Looks for the Java command line '-Dcloudgraph.configuration' setting for the name of the mapping configuration file. If not found looks for the default file name 'cloudgraph-config.xml'. The CloudGraph mapping configuration file must be somewhere on the Java class path.

Since:

0.5

Author:

Scott Cinnamond

Method Summary

Modifier and Type	Method and Description
void	addTable(TableMapping tableConfig) Adds the given configuration
void	addTableIfNotExists(TableMapping tableConfig) Adds the given configuration if not already exists
DataGraphMapping	findDataGraph(QName typeName, StoreMappingContext context) Returns a data graph config for the given qualified SDO Type name or null of not exists.
Property	findProperty(String name)
TableMapping	findTable(QName typeName, StoreMappingContext context) Returns a table configuration for the given qualified SDO Type name or null if not found.
TableMapping	findTable(commonj.sdo.Type type, StoreMappingContext context) Returns a table configuration for the given SDO Type or null if not found.
TableMapping	findTableByQualifiedLogicalName(String qualifiedLogicaltableName, StoreMappingContext context) Returns a table configuration based on the given table name.
Charset	getCharset()
ConfigProperties	getConfigProperties()
DataGraphMapping	getDataGraph(QName typeName, StoreMappingContext context) Returns a data graph mapping for the given qualified SDO Type name.
List<TableMapping>	getDynamicTables(StoreMappingContext context) Returns all tables dynamically defined, that is those tables defined dynamically at runtime
static MappingConfiguration	getInstance()
List<Property>	getProperties()
List<TableMapping>	getStaticTables(StoreMappingContext context) Returns all tables not dynamically defined, that is those tables defined within a static mapping resource / file.
TableMapping	getTable(QName typeName, StoreMappingContext context) Returns a table configuration for the given qualified SDO Type name.
TableMapping	getTable(commonj.sdo.Type type, StoreMappingContext context) Returns a table configuration for the given SDO Type.
TableMapping	getTableByQualifiedLogicalName(String qualifiedLogicalTableName, StoreMappingContext context) Returns a table mapping based on the given table name.
void	marshal(OutputStream stream)
boolean	optimisticConcurrency()
void	removeTable(TableMapping tableConfig) Adds the given configuration
void	removeTableIfExists(TableMapping tableConfig) Adds the given configuration if exists
String	tableNamespaceRoot()
String	tableVolumeName()
boolean	tombstoneRows()
boolean	tombstoneRowsOverwriteable()
boolean	uniqueChecks()

Methods inherited from class java.lang.Object

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

Method Detail

marshal

public void marshal(OutputStream stream)

Specified by:

marshal in interface MappingConfiguration

getInstance

public static MappingConfiguration getInstance()
                                        throws StoreMappingException

Throws:

StoreMappingException

getConfigProperties

public ConfigProperties getConfigProperties()

Specified by:

getConfigProperties in interface MappingConfiguration

getProperties

public List<Property> getProperties()

Specified by:

getProperties in interface MappingConfiguration

findProperty

public Property findProperty(String name)

Specified by:

findProperty in interface MappingConfiguration

getStaticTables

public List<TableMapping> getStaticTables(StoreMappingContext context)

Description copied from interface: MappingConfiguration

Returns all tables not dynamically defined, that is those tables defined within a static mapping resource / file.

Specified by:

getStaticTables in interface MappingConfiguration

Parameters:

context - the mapping context

Returns:

all tables not dynamically defined, that is those tables defined within a static mapping resource / file.

getDynamicTables

public List<TableMapping> getDynamicTables(StoreMappingContext context)

Description copied from interface: MappingConfiguration

Returns all tables dynamically defined, that is those tables defined dynamically at runtime

Specified by:

getDynamicTables in interface MappingConfiguration

Parameters:

context - the mapping context

Returns:

all tables dynamically defined, that is those tables defined dynamically at runtime

findTable

public TableMapping findTable(QName typeName,
                              StoreMappingContext context)

Description copied from interface: MappingConfiguration

Returns a table configuration for the given qualified SDO Type name or null if not found.

Specified by:

findTable in interface MappingConfiguration

Parameters:

typeName - the qualified name of an SDO Type

Returns:

the table configuration or null if not found

getTable

public TableMapping getTable(QName typeName,
                             StoreMappingContext context)

Description copied from interface: MappingConfiguration

Returns a table configuration for the given qualified SDO Type name.

Specified by:

getTable in interface MappingConfiguration

Parameters:

typeName - the qualified name of an SDO Type

Returns:

the table configuration

findTable

public TableMapping findTable(commonj.sdo.Type type,
                              StoreMappingContext context)

Description copied from interface: MappingConfiguration

Returns a table configuration for the given SDO Type or null if not found.

Specified by:

findTable in interface MappingConfiguration

Parameters:

type - the SDO Type

Returns:

the table configuration or null if not found

getTable

public TableMapping getTable(commonj.sdo.Type type,
                             StoreMappingContext context)

Description copied from interface: MappingConfiguration

Returns a table configuration for the given SDO Type.

Specified by:

getTable in interface MappingConfiguration

Parameters:

type - the SDO Type

Returns:

the table configuration

findTableByQualifiedLogicalName

public TableMapping findTableByQualifiedLogicalName(String qualifiedLogicaltableName,
                                                    StoreMappingContext context)

Description copied from interface: MappingConfiguration

Returns a table configuration based on the given table name.

Specified by:

findTableByQualifiedLogicalName in interface MappingConfiguration

Parameters:

qualifiedLogicaltableName - the table name or null if not found.

Returns:

the table configuration or null if not found.

getTableByQualifiedLogicalName

public TableMapping getTableByQualifiedLogicalName(String qualifiedLogicalTableName,
                                                   StoreMappingContext context)

Description copied from interface: MappingConfiguration

Returns a table mapping based on the given table name.

Specified by:

getTableByQualifiedLogicalName in interface MappingConfiguration

Returns:

the table configuration

addTable

public void addTable(TableMapping tableConfig)

Description copied from interface: MappingConfiguration

Adds the given configuration

Specified by:

addTable in interface MappingConfiguration

Parameters:

tableConfig - the table configuration

addTableIfNotExists

public void addTableIfNotExists(TableMapping tableConfig)

Description copied from interface: MappingConfiguration

Adds the given configuration if not already exists

Specified by:

addTableIfNotExists in interface MappingConfiguration

Parameters:

tableConfig - the table configuration

removeTable

public void removeTable(TableMapping tableConfig)

Description copied from interface: MappingConfiguration

Adds the given configuration

Specified by:

removeTable in interface MappingConfiguration

Parameters:

tableConfig - the table configuration

removeTableIfExists

public void removeTableIfExists(TableMapping tableConfig)

Description copied from interface: MappingConfiguration

Adds the given configuration if exists

Specified by:

removeTableIfExists in interface MappingConfiguration

Parameters:

tableConfig - the table configuration

findDataGraph

public DataGraphMapping findDataGraph(QName typeName,
                                      StoreMappingContext context)

Description copied from interface: MappingConfiguration

Returns a data graph config for the given qualified SDO Type name or null of not exists.

Specified by:

findDataGraph in interface MappingConfiguration

Returns:

a data graph mapping for the given qualified SDO Type name or null of not exists.

getDataGraph

public DataGraphMapping getDataGraph(QName typeName,
                                     StoreMappingContext context)

Description copied from interface: MappingConfiguration

Returns a data graph mapping for the given qualified SDO Type name.

Specified by:

getDataGraph in interface MappingConfiguration

Returns:

a data graph mapping for the given qualified SDO Type name.

getCharset

public Charset getCharset()

Specified by:

getCharset in interface MappingConfiguration

uniqueChecks

public boolean uniqueChecks()

Specified by:

uniqueChecks in interface MappingConfiguration

tombstoneRows

public boolean tombstoneRows()

Specified by:

tombstoneRows in interface MappingConfiguration

tombstoneRowsOverwriteable

public boolean tombstoneRowsOverwriteable()

Specified by:

tombstoneRowsOverwriteable in interface MappingConfiguration

tableVolumeName

public String tableVolumeName()

Specified by:

tableVolumeName in interface MappingConfiguration

tableNamespaceRoot

public String tableNamespaceRoot()

Specified by:

tableNamespaceRoot in interface MappingConfiguration

optimisticConcurrency

public boolean optimisticConcurrency()

Specified by:

optimisticConcurrency in interface MappingConfiguration