org.cloudgraph.store.mapping

Interface MappingConfiguration

All Known Implementing Classes:

StoreMapping

public interface MappingConfiguration

Method Summary

Modifier and Type	Method and Description
void	addTable(TableMapping table) Adds the given configuration
void	addTableIfNotExists(TableMapping table) Adds the given configuration if not already exists
DataGraphMapping	findDataGraph(QName qname, 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 tableName, StoreMappingContext context) Returns a table configuration based on the given table name.
Charset	getCharset()
ConfigProperties	getConfigProperties()
DataGraphMapping	getDataGraph(QName qname, 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
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 qualifiedTableName, StoreMappingContext context) Returns a table mapping based on the given table name.
void	marshal(OutputStream stream)
boolean	optimisticConcurrency()
void	removeTable(TableMapping table) Adds the given configuration
void	removeTableIfExists(TableMapping table) Adds the given configuration if exists
String	tableNamespaceRoot()
String	tableVolumeName()
boolean	tombstoneRows()
boolean	tombstoneRowsOverwriteable()
boolean	uniqueChecks()

Method Detail

marshal

void marshal(OutputStream stream)

getProperties

List<Property> getProperties()

findProperty

Property findProperty(String name)

getConfigProperties

ConfigProperties getConfigProperties()

getStaticTables

List<TableMapping> getStaticTables(StoreMappingContext context)

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

Parameters:

context - the mapping context

Returns:

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

getDynamicTables

List<TableMapping> getDynamicTables(StoreMappingContext context)

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

Parameters:

context - the mapping context

Returns:

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

findTable

TableMapping findTable(QName typeName,
                       StoreMappingContext context)

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

Parameters:

typeName - the qualified name of an SDO Type

Returns:

the table configuration or null if not found

getTable

TableMapping getTable(QName typeName,
                      StoreMappingContext context)

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

Parameters:

typeName - the qualified name of an SDO Type

Returns:

the table configuration

Throws:

StoreMappingException - if the given name is not found

findTable

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

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

Parameters:

type - the SDO Type

Returns:

the table configuration or null if not found

getTable

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

Returns a table configuration for the given SDO Type.

Parameters:

type - the SDO Type

Returns:

the table configuration

Throws:

StoreMappingException - if the given type is not found

findTableByQualifiedLogicalName

TableMapping findTableByQualifiedLogicalName(String tableName,
                                             StoreMappingContext context)

Returns a table configuration based on the given table name.

Parameters:

tableName - the table name or null if not found.

Returns:

the table configuration or null if not found.

getTableByQualifiedLogicalName

TableMapping getTableByQualifiedLogicalName(String qualifiedTableName,
                                            StoreMappingContext context)

Returns a table mapping based on the given table name.

Parameters:

tableName - the table name

Returns:

the table configuration

Throws:

StoreMappingException - if the given name is not found

addTable

void addTable(TableMapping table)

Adds the given configuration

Parameters:

table - the table configuration

addTableIfNotExists

void addTableIfNotExists(TableMapping table)

Adds the given configuration if not already exists

Parameters:

table - the table configuration

removeTable

void removeTable(TableMapping table)

Adds the given configuration

Parameters:

table - the table configuration

removeTableIfExists

void removeTableIfExists(TableMapping table)

Adds the given configuration if exists

Parameters:

table - the table configuration

findDataGraph

DataGraphMapping findDataGraph(QName qname,
                               StoreMappingContext context)

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

Parameters:

typeName - the qualified name of an SDO Type

Returns:

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

getDataGraph

DataGraphMapping getDataGraph(QName qname,
                              StoreMappingContext context)

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

Parameters:

typeName - the qualified name of an SDO Type

Returns:

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

Throws:

StoreMappingException - if no configured data graph exists for the given qualified SDO Type name

getCharset

Charset getCharset()

uniqueChecks

boolean uniqueChecks()

tombstoneRows

boolean tombstoneRows()

tombstoneRowsOverwriteable

boolean tombstoneRowsOverwriteable()

tableNamespaceRoot

String tableNamespaceRoot()

tableVolumeName

String tableVolumeName()

optimisticConcurrency

boolean optimisticConcurrency()