Package org.datanucleus.store.rdbms.schema

Class RDBMSSchemaInfo

java.lang.Object

org.datanucleus.store.rdbms.schema.RDBMSSchemaInfo

All Implemented Interfaces:

org.datanucleus.store.schema.MapStoreSchemaData, org.datanucleus.store.schema.StoreSchemaData

public class RDBMSSchemaInfo
extends Object
implements org.datanucleus.store.schema.MapStoreSchemaData

Representation of schema table information in the datastore. Stores a map of tables, keyed by the table name. Supports the following properties :-

• catalog Catalog containing the tables
• schema Schema containing the tables

Constructor Summary

Constructors

Constructor	Description
RDBMSSchemaInfo(String catalog, String schema)

Method Summary

Modifier and Type	Method	Description
void	addChild(org.datanucleus.store.schema.StoreSchemaData data)	Method to add another table to the schema.
void	addProperty(String name, Object value)	Method to add a property for the schema.
void	clearChildren()	Method to remove all children.
boolean	equals(Object obj)	Indicates whether some object is "equal to" this one.
org.datanucleus.store.schema.StoreSchemaData	getChild(String key)	Accessor for the table with this key.
Map<String,org.datanucleus.store.schema.StoreSchemaData>	getChildren()	Accessor for the tables.
int	getNumberOfChildren()	Accessor for the number of tables in the schema for this schema.
org.datanucleus.store.schema.StoreSchemaData	getParent()
Object	getProperty(String name)	Accessor for a property of the schema.
int	hashCode()	Returns a hash code value for this object.
void	setParent(org.datanucleus.store.schema.StoreSchemaData parent)
String	toString()	Returns the string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

RDBMSSchemaInfo

public RDBMSSchemaInfo(String catalog,
                       String schema)

Method Detail

addChild

public void addChild(org.datanucleus.store.schema.StoreSchemaData data)

Method to add another table to the schema. Will key the table into its Map using the table property "table_key".

Specified by:

addChild in interface org.datanucleus.store.schema.MapStoreSchemaData

Parameters:

data - Child information (RDBMSTableInfo)

Throws:

org.datanucleus.exceptions.NucleusException - Thrown if the table has no property "table_key"

clearChildren

public void clearChildren()

Method to remove all children.

Specified by:

clearChildren in interface org.datanucleus.store.schema.MapStoreSchemaData

getChild

public org.datanucleus.store.schema.StoreSchemaData getChild(String key)

Accessor for the table with this key.

Specified by:

getChild in interface org.datanucleus.store.schema.MapStoreSchemaData

Parameters:

key - Key of the table

Returns:

Table with this key

getChildren

public Map<String,org.datanucleus.store.schema.StoreSchemaData> getChildren()

Accessor for the tables.

Specified by:

getChildren in interface org.datanucleus.store.schema.MapStoreSchemaData

Returns:

Tables

getNumberOfChildren

public int getNumberOfChildren()

Accessor for the number of tables in the schema for this schema.

Specified by:

getNumberOfChildren in interface org.datanucleus.store.schema.MapStoreSchemaData

Returns:

Number of tables

addProperty

public void addProperty(String name,
                        Object value)

Method to add a property for the schema.

Specified by:

addProperty in interface org.datanucleus.store.schema.StoreSchemaData

Parameters:

name - Name of property

value - Its value

getProperty

public Object getProperty(String name)

Accessor for a property of the schema.

Specified by:

getProperty in interface org.datanucleus.store.schema.StoreSchemaData

Parameters:

name - Name of the property

Returns:

Its value, or null if not defined

getParent

public org.datanucleus.store.schema.StoreSchemaData getParent()

Specified by:

getParent in interface org.datanucleus.store.schema.MapStoreSchemaData

setParent

public void setParent(org.datanucleus.store.schema.StoreSchemaData parent)

Specified by:

setParent in interface org.datanucleus.store.schema.MapStoreSchemaData

equals

public final boolean equals(Object obj)

Indicates whether some object is "equal to" this one. Two RDBMSSchemaInfo are considered equal if their catalog, schema are all equal.

Overrides:

equals in class Object

Parameters:

obj - the reference object with which to compare

Returns:

true if this object is equal to the obj argument; false otherwise.

hashCode

public final int hashCode()

Returns a hash code value for this object.

Overrides:

hashCode in class Object

Returns:

hash code

toString

public String toString()

Returns the string representation of this object.

Overrides:

toString in class Object

Returns:

string representation of this object.