org.cloudgraph.store.mapping.annotation

Annotation Type Table

@Target(value=TYPE)
 @Retention(value=RUNTIME)
 @IndexAnnotated
public @interface Table

Runtime discoverable mapping to a physical data store table.

Since:

1.0.8

Author:

Scott Cinnamond

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	name The physical data store table name.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	dataColumnFamilyName The data column family name.
HashAlgorithmName	hashAlgorithm The hash algorithm used for hashing any row key fields.
String	maprdbTablePathPrefix The path to prepend to all MAPRD-DB (M7) table names for tables found within a configuration.
String[]	properties Returns an array of property name value pairs delimited by the '=' char.
String	rowKeyFieldDelimiter The character used to delimit composite row keys for the table
boolean	tombstoneRows Whether to create a tombstone rows when deleting a graph roots.
boolean	tombstoneRowsOverwriteable Whether to ignore and overwrite tombstone rows when creating new graph roots.
boolean	uniqueChecks Whether to first check for an existing matching row key before creating/inserting new rows.

Element Detail

name

public abstract String name

The physical data store table name.

Returns:

The physical data store table name.

dataColumnFamilyName

public abstract String dataColumnFamilyName

The data column family name.

Returns:

The data column family name.

Default:

"f1"

rowKeyFieldDelimiter

public abstract String rowKeyFieldDelimiter

The character used to delimit composite row keys for the table

Returns:

The character used to delimit composite row keys for the table

Default:

"|"

hashAlgorithm

public abstract HashAlgorithmName hashAlgorithm

The hash algorithm used for hashing any row key fields.

Returns:

The hash algorithm used for hashing any row key fields.

Default:

org.cloudgraph.store.mapping.HashAlgorithmName.NONE

uniqueChecks

public abstract boolean uniqueChecks

Whether to first check for an existing matching row key before creating/inserting new rows.

Returns:

Whether to first check for an existing matching row key before creating/inserting new rows.

Default:

true

tombstoneRows

public abstract boolean tombstoneRows

Whether to create a tombstone rows when deleting a graph roots. Warning setting this property to false could cause dangling references for models with "one way" associations navigating to the concerned root which are non-navigable from the root.

Returns:

Whether to create a tombstone rows when deleting a graph roots. Warning setting this property to false could cause dangling references for models with "one way" associations navigating to the concerned root which are non-navigable from the root.

Default:

true

tombstoneRowsOverwriteable

public abstract boolean tombstoneRowsOverwriteable

Whether to ignore and overwrite tombstone rows when creating new graph roots.

Returns:

Whether to ignore and overwrite tombstone rows when creating new graph roots.

Default:

true

maprdbTablePathPrefix

public abstract String maprdbTablePathPrefix

The path to prepend to all MAPRD-DB (M7) table names for tables found within a configuration. Used for only MAPR-DB (M7) tables. To fully qualify Apache HBase tables, use table namespaces.

Returns:

The path to prepend to all MAPRD-DB (M7) table names for tables found within a configuration.

Default:

""

properties

public abstract String[] properties

Returns an array of property name value pairs delimited by the '=' char. E.g. String[] = { foo=bar }

Returns:

an array of property name value pairs

Default:

{}