com.webobjects.eoaccess.synchronization
Class EOSchemaTableDescription

java.lang.Object
  com.webobjects.eoaccess.synchronization.EOSchemaPropertyDescription
      com.webobjects.eoaccess.synchronization.EOSchemaTableDescription

All Implemented Interfaces:

NSKeyValueCoding, NSKeyValueCodingAdditions

Direct Known Subclasses:

FrontbasePlugIn.FrontbaseSynchronizationFactory.FrontbaseTableDescription, OpenBasePlugIn.OpenBaseSynchronizationFactory.OpenBaseTableDescription

public class EOSchemaTableDescription
extends EOSchemaPropertyDescription

A wrapper object for relational database table information used for schema synchronization. This encapsulates column, index, relationship and foreign key constraint information.

Since:

5.4

See Also:

EOSchemaColumnDescription, EOSchemaForeignKeyConstraintDescription, EOSchemaIndexDescription, EOSchemaSynchronizationFactory

Nested Class Summary

Nested classes/interfaces inherited from interface com.webobjects.foundation.NSKeyValueCodingAdditions

NSKeyValueCodingAdditions.DefaultImplementation, NSKeyValueCodingAdditions.Utility

Nested classes/interfaces inherited from interface com.webobjects.foundation.NSKeyValueCoding

NSKeyValueCoding.ErrorHandling, NSKeyValueCoding.MapImplementation, NSKeyValueCoding.Null, NSKeyValueCoding.UnknownKeyException, NSKeyValueCoding.ValueAccessor

Field Summary

static EOSchemaTableDescription

EmptyDescription

Fields inherited from interface com.webobjects.foundation.NSKeyValueCodingAdditions

KeyPathSeparator

Fields inherited from interface com.webobjects.foundation.NSKeyValueCoding

NullValue

Constructor Summary

protected

EOSchemaTableDescription()

Method Summary

protected void	addToColumns(EOSchemaColumnDescription value)
protected void	addToForeignKeyConstraints(EOSchemaForeignKeyConstraintDescription value)
protected void	addToIndexes(EOSchemaIndexDescription value)
Iterator	columnIterator()
NSArray	columns()
protected void	fieldsToString(StringBuilder aLog) Adds the fields for each subclass.
Iterator	foreignKeyConstraintIterator()
NSArray	foreignKeyConstraints()
EOSchemaColumnDescription	getColumnByName(String value)
EOSchemaForeignKeyConstraintDescription	getForeignKeyConstraintByName(String value)
EOSchemaIndexDescription	getIndexByName(String value)
NSArray	indexes()
Iterator	indexIterator()
boolean	isEmpty() Returns true is the property description is empty
EOSchemaColumnDescription	newColumnDescription() Returns a newly initialized column description object.
EOSchemaForeignKeyConstraintDescription	newForeignKeyConstraintDescription() Returns a newly initialized foreign key constraint description object.
EOSchemaIndexDescription	newIndexDescription() Returns a newly initialized index description object.
protected void	removeFromColumns(EOSchemaColumnDescription value)
protected void	removeFromForeignKeyConstraints(EOSchemaForeignKeyConstraintDescription value)
protected void	removeFromIndexes(EOSchemaIndexDescription value)

Methods inherited from class com.webobjects.eoaccess.synchronization.EOSchemaPropertyDescription

name, setName, takeValueForKey, takeValueForKeyPath, toString, valueForKey, valueForKeyPath

Methods inherited from class java.lang.Object

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

Field Detail

EmptyDescription

public static final EOSchemaTableDescription EmptyDescription

Constructor Detail

EOSchemaTableDescription

protected EOSchemaTableDescription()

Method Detail

isEmpty

public boolean isEmpty()

Description copied from class: EOSchemaPropertyDescription

Returns true is the property description is empty

Specified by:

isEmpty in class EOSchemaPropertyDescription

Returns:

true if empty

newColumnDescription

public EOSchemaColumnDescription newColumnDescription()

Returns a newly initialized column description object. This object is not inserted in the description list. This is to facilitate subclassing.

Returns:

a new description object

columns

public NSArray columns()

getColumnByName

public EOSchemaColumnDescription getColumnByName(String value)

addToColumns

protected void addToColumns(EOSchemaColumnDescription value)

removeFromColumns

protected void removeFromColumns(EOSchemaColumnDescription value)

columnIterator

public Iterator columnIterator()

newIndexDescription

public EOSchemaIndexDescription newIndexDescription()

Returns a newly initialized index description object. This object is not inserted in the description list. This is to facilitate subclassing.

Returns:

a new description object

indexes

public NSArray indexes()

getIndexByName

public EOSchemaIndexDescription getIndexByName(String value)

addToIndexes

protected void addToIndexes(EOSchemaIndexDescription value)

removeFromIndexes

protected void removeFromIndexes(EOSchemaIndexDescription value)

indexIterator

public Iterator indexIterator()

newForeignKeyConstraintDescription

public EOSchemaForeignKeyConstraintDescription newForeignKeyConstraintDescription()

Returns a newly initialized foreign key constraint description object. This object is not inserted in the description list. This is to facilitate subclassing.

Returns:

a new description object

foreignKeyConstraints

public NSArray foreignKeyConstraints()

getForeignKeyConstraintByName

public EOSchemaForeignKeyConstraintDescription getForeignKeyConstraintByName(String value)

addToForeignKeyConstraints

protected void addToForeignKeyConstraints(EOSchemaForeignKeyConstraintDescription value)

removeFromForeignKeyConstraints

protected void removeFromForeignKeyConstraints(EOSchemaForeignKeyConstraintDescription value)

foreignKeyConstraintIterator

public Iterator foreignKeyConstraintIterator()

fieldsToString

protected void fieldsToString(StringBuilder aLog)

Description copied from class: EOSchemaPropertyDescription

Adds the fields for each subclass. Subclasses must override this method and call super first if they have specific fields to display.

Overrides:

fieldsToString in class EOSchemaPropertyDescription

Parameters:

aLog - log statement being built