org.jpox.store.rdbms.sqlidentifier
Class SQLIdentifier

java.lang.Object
  org.jpox.store.rdbms.sqlidentifier.SQLIdentifier

All Implemented Interfaces:

DatastoreIdentifier

public class SQLIdentifier
extends java.lang.Object
implements DatastoreIdentifier

Representation of an identifier in SQL. This can be something like a table name, column name, PK name, etc.

Version:

$Revision: 1.25 $

Field Summary

protected java.lang.String	catalogName catalog name
protected DatastoreAdapter	dba Datastore adapter
protected IdentifierFactory	factory Datastore Identifier factory.
protected java.lang.String	schemaName schema/owner name
protected java.lang.String	sqlIdentifier The SQL identifier

Constructor Summary

protected

SQLIdentifier(IdentifierFactory factory, java.lang.String sqlIdentifier) Constructor.

Method Summary

boolean	equals(java.lang.Object obj) Equality operator to judge if 2 identifiers are equal.
java.lang.String	getCatalogName() Accessor for the catalog name
java.lang.String	getFullyQualifiedName(boolean adapterCase) Accessor for a fully-qualified version of the identifier name.
java.lang.String	getIdentifier() Accessor for the (SQL) identifier as a string.
java.lang.String	getSchemaName() Accessor for the schema name
int	hashCode() Hash code method.
void	setCatalogName(java.lang.String catalogName) Sets the catalog name
void	setSchemaName(java.lang.String schemaName) Sets the schema name
protected java.lang.String	toCase(java.lang.String sqlIdentifier) Mutator for the sql identifier.
java.lang.String	toString() Method to output the name of the identifier.

Methods inherited from class java.lang.Object

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

Field Detail

dba

protected final DatastoreAdapter dba

Datastore adapter

factory

protected final IdentifierFactory factory

Datastore Identifier factory.

sqlIdentifier

protected java.lang.String sqlIdentifier

The SQL identifier

catalogName

protected java.lang.String catalogName

catalog name

schemaName

protected java.lang.String schemaName

schema/owner name

Constructor Detail

SQLIdentifier

protected SQLIdentifier(IdentifierFactory factory,
                        java.lang.String sqlIdentifier)

Constructor.

Parameters:

factory - Identifier factory

sqlIdentifier - The SQL identifier name

Method Detail

toCase

protected java.lang.String toCase(java.lang.String sqlIdentifier)

Mutator for the sql identifier. Takes account of the DB policy on upper, lower and mixed case identifiers. Optionally can truncate the identifier if it exceeds the "getMaxLength()".

Parameters:

sqlIdentifier - The SQL Identifier

getIdentifier

public java.lang.String getIdentifier()

Accessor for the (SQL) identifier as a string. TODO Rename this to getName() since it doesnt return an identifier, it returns the name.

Specified by:

getIdentifier in interface DatastoreIdentifier

Returns:

String form of the (SQL) identifier.

hashCode

public int hashCode()

Hash code method.

Overrides:

hashCode in class java.lang.Object

Returns:

The hash code

equals

public boolean equals(java.lang.Object obj)

Equality operator to judge if 2 identifiers are equal.

• Comparing NULL schema/owner names in one or both objects evaluates to true
• Comparing NULL catalog names in one or both objects evaluates to true

TODO change the below behavior. will require changing all places creating an identifier to set the catalog name and schema name from jdo metadata and/or metadata collected from the db

Overrides:

equals in class java.lang.Object

Parameters:

obj - Object to compare against

Returns:

Whether they are equal

toString

public java.lang.String toString()

Method to output the name of the identifier. This will be quoted where necessary. Will not include the catalog/schema names.

Specified by:

toString in interface DatastoreIdentifier

Overrides:

toString in class java.lang.Object

Returns:

The identifier name with any necessary quoting

setCatalogName

public void setCatalogName(java.lang.String catalogName)

Sets the catalog name

Parameters:

catalogName - The catalog name

setSchemaName

public void setSchemaName(java.lang.String schemaName)

Sets the schema name

Parameters:

schemaName - The schema name

getCatalogName

public java.lang.String getCatalogName()

Accessor for the catalog name

Returns:

The catalog name

getSchemaName

public java.lang.String getSchemaName()

Accessor for the schema name

Returns:

The schema name

getFullyQualifiedName

public final java.lang.String getFullyQualifiedName(boolean adapterCase)

Accessor for a fully-qualified version of the identifier name. Allows for catalog/schema (if specified and if supported)

Specified by:

getFullyQualifiedName in interface DatastoreIdentifier

Parameters:

adapterCase - Whether to use adapter case for the returned name

Returns:

The fully-qualified name