SMACS

smacs.load.schema
Class DbSchemaTableNode

java.lang.Object
  extended byorg.dom4j.tree.AbstractNode
      extended byorg.dom4j.tree.AbstractBranch
          extended byorg.dom4j.tree.AbstractElement
              extended byorg.dom4j.tree.DefaultElement
                  extended bysmacs.tree.ScriptNode
                      extended bysmacs.load.schema.DbSchemaScriptNode
                          extended bysmacs.load.schema.DbSchemaTableNode
All Implemented Interfaces:
Branch, Cloneable, CreateListener, DbSchemaSimpleNode, DbSchemaTable, DbSchemaTableQName, Element, EventListener, FixNode, FixNodeListener, GetName, GetSimpleNode, HasNodeHandler, HasNodeReferenceAttribute, smacs.tree.HasNodeReferenceId, HasTableName, HasTableQName, HasTableSchemaName, HasTableSchemaNameSpec, IsaNodeReferenceChildListener, IsaNodeReferenceListener, NewSimpleNode, Node, Node, Serializable, SimpleElement, SimpleNode, SimpleNodeChild, SmacsFixNode, TableQ2Name, TableQName

public class DbSchemaTableNode
extends DbSchemaScriptNode
implements DbSchemaTable

internal representation of a database table.

See Also:
Serialized Form

Field Summary
protected static Logger log
           
 
Fields inherited from class smacs.tree.ScriptNode
_NodeHandler, TokenValue
 
Fields inherited from class org.dom4j.tree.AbstractElement
EMPTY_ITERATOR, EMPTY_LIST, USE_STRINGVALUE_SEPARATOR, VERBOSE_TOSTRING
 
Fields inherited from class org.dom4j.tree.AbstractBranch
DEFAULT_CONTENT_LIST_SIZE, outputFormat
 
Fields inherited from class org.dom4j.tree.AbstractNode
NODE_TYPE_NAMES
 
Fields inherited from interface smacs.tree.SimpleNode
TokenValue
 
Fields inherited from interface org.dom4j.Node
ANY_NODE, ATTRIBUTE_NODE, CDATA_SECTION_NODE, COMMENT_NODE, DOCUMENT_NODE, DOCUMENT_TYPE_NODE, ELEMENT_NODE, ENTITY_REFERENCE_NODE, MAX_NODE_TYPE, NAMESPACE_NODE, PROCESSING_INSTRUCTION_NODE, TEXT_NODE, UNKNOWN_NODE
 
Constructor Summary
DbSchemaTableNode(SmacsFixNodeLater later)
           
DbSchemaTableNode(SqlTableReferenceQ table)
           
DbSchemaTableNode(String tablename, String schemaname)
           
DbSchemaTableNode(TableQName table)
           
 
Method Summary
 void addColumn(DbSchemaColumn column)
           
 void addColumn(SqlTableColumnQ column)
           
 void addForeignKey(DbSchemaForeignKey constraint)
           
 void addUniqueFields(DbSchemaUniqueFields constraint)
           
 List getColumnList()
          get the columns of this table as a list.
 List getForeignKeyList()
          get the foreignkeys of this table as a list.
 String getTableName()
          the table name.
 String getTableNameSpec()
           
 String getTableSchemaBaseNameSpec()
          a syntactic qualifier for the schema name part.
 String getTableSchemaName()
          the table schema name.
 String getTableSchemaNameSpec()
          any syntactic qualifier of the table schema name.
 List getUniqueFieldsList()
           
 DbSchemaColumn hasColumn(String name)
          find column within table definition.
 boolean hasForeignKeyTo(DbSchemaTableQName table)
          check foreign key assertion.
 DbSchemaTableList hasParentTableList()
           
 String hasParentTableListName()
           
 String hasSchemaName()
          the schema name.
 void setTableName(String tablename)
           
 void setTableSchemaName(String schemaname)
           
 
Methods inherited from class smacs.load.schema.DbSchemaScriptNode
_expandForeignKeyColumns, _expandForeignKeyReferences, expandForeignKeyColumns, expandForeignKeyReferences, newNode, newNode, newNode
 
Methods inherited from class smacs.tree.ScriptNode
_fixNodeTree, _getTokenValue, _getValueTokenValue, _hasTokenValue, _init, add, add, addAll, addAll, addChild, addChild, addNewNode, addNodeReference, addNodeReference, addNodeReference, addNodeReference, appendAttributes, appendText, clear, cloneFrom, contains, containsAll, countTokenName, dump, fireNodeReferenceChildHasChanged, fireNodeReferenceHasChanged, firstTokenName, firstTokenName, fixNode, fixNodeTree, get, getAttributeValue, getHandler, getId, getMember, getMember, getMember, getMember, getMemberChild, getMemberChild, getMemberChild, getMemberList, getMemberListChild, getMemberOption, getMemberOption, getMemberOption, getMemberValue, getMemberValue, getMemberValue, getNodeNameFromClassName, getNodeReferenceCount, getNodeReferenceCount, getNodeReferenceId, getNodeReferenceId, getOption, getOption, getOption, getParentNode, getParentNode, getParentNode, getParentNode, getSimpleNode, getSingleTextChild, getThisParentNode, getThisParentNode, getTokenName, getTokenValue, hasChildren, hasMember, hasMember, hasNodeHandler, hasNodeReference, hasNodeReferenceChildNodes, hasNodeReferenceChildNodes, hasNodeReferenceId, hasNodeReferenceId, hasSingleTextChild, hasTokenName, hasTokenValue, indexOf, isEmpty, iterator, jjtAccept, jjtAddChild, jjtClose, jjtGetChild, jjtGetNumChildren, jjtGetParent, jjtOpen, jjtSetParent, lastIndexOf, lastTokenName, lastTokenName, listIterator, listIterator, memberElement, newChildren, newNode, newNode, newNode, newNode, newNode, newNode, newNode, newNodeLike, newNodeReferenceAttribute, newNodeReferenceAttribute, newNodeReferenceId, newNodeReferenceId, onNodeReferenceChildHasChanged, onNodeReferenceHasChanged, printXML, printXML, removeAll, removeAttribute, removeChild, removeChild, removeNodeReference, replace, retainAll, set, setHandler, setMemberChild, setMemberChild, setMemberChild, setMemberList, setMemberListChild, setMemberOption, setMemberOption, setMemberOption, setMemberValue, setMemberValue, setMemberValue, setNodeReference, setNodeReference, setNodeReference, setOption, setOption, setOption, setOption, setTokenName, setTokenValue, size, strSingleTextChild, subList, toArray, toArray, toString, toString, toXML, toXML
 
Methods inherited from class org.dom4j.tree.DefaultElement
add, additionalNamespaces, additionalNamespaces, addNewNode, attribute, attribute, attribute, attribute, attributeCount, attributeIterator, attributeList, attributeList, attributes, clearContent, clone, contentList, declaredNamespaces, element, element, element, elementIterator, elementIterator, elementIterator, elementIterator, elements, elements, elements, elements, getDocument, getDocumentFactory, getNamespaceForPrefix, getNamespaceForURI, getParent, getQName, getStringValue, getText, indexOf, node, nodeCount, nodeIterator, processingInstruction, processingInstructions, processingInstructions, remove, removeNode, removeProcessingInstruction, setAttributeList, setAttributes, setContent, setDocument, setParent, setQName, supportsParent
 
Methods inherited from class org.dom4j.tree.AbstractElement
accept, add, add, add, add, add, add, add, add, addAttribute, addAttribute, addCDATA, addComment, addElement, addEntity, addNamespace, addNode, addProcessingInstruction, addProcessingInstruction, addText, asXML, attributeValue, attributeValue, attributeValue, attributeValue, childAdded, childRemoved, createAttributeList, createAttributeList, createCopy, createCopy, createCopy, createElement, createElement, createSingleIterator, elementText, elementText, elementTextTrim, elementTextTrim, ensureAttributesCapacity, getData, getName, getNamespace, getNamespacePrefix, getNamespaceURI, getNodeType, getPath, getQName, getQualifiedName, getUniquePath, getXPathNameStep, getXPathResult, hasMixedContent, isRootElement, isTextOnly, normalize, remove, remove, remove, remove, remove, remove, remove, remove, setAttributes, setAttributeValue, setAttributeValue, setData, setName, setNamespace, setText, write
 
Methods inherited from class org.dom4j.tree.AbstractBranch
addElement, addElement, addElement, appendContent, content, contentRemoved, createContentList, createContentList, createEmptyList, createResultList, createSingleResultList, elementByID, elementID, getContentAsStringValue, getContentAsText, getTextTrim, hasContent, invalidNodeTypeAddException, isReadOnly, setProcessingInstructions
 
Methods inherited from class org.dom4j.tree.AbstractNode
asXPathResult, createPattern, createXPath, createXPathFilter, createXPathResult, detach, getNodeTypeName, getPath, getUniquePath, matches, numberValueOf, selectNodes, selectNodes, selectNodes, selectObject, selectSingleNode, valueOf
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface smacs.tree.SimpleNode
add, add, addAll, addAll, addChild, addChild, addNewNode, addNodeReference, addNodeReference, addNodeReference, addNodeReference, appendAttributes, appendText, clear, cloneFrom, contains, containsAll, countTokenName, dump, fireNodeReferenceChildHasChanged, fireNodeReferenceHasChanged, firstTokenName, firstTokenName, fixNode, fixNodeTree, get, getAttributeValue, getHandler, getId, getMember, getMember, getMember, getMember, getMemberChild, getMemberChild, getMemberChild, getMemberList, getMemberListChild, getMemberOption, getMemberOption, getMemberOption, getMemberValue, getMemberValue, getMemberValue, getNodeReferenceCount, getNodeReferenceCount, getNodeReferenceId, getNodeReferenceId, getOption, getOption, getOption, getParentNode, getParentNode, getParentNode, getParentNode, getSimpleNode, getSingleTextChild, getThisParentNode, getThisParentNode, getTokenName, getTokenValue, hasChildren, hasMember, hasMember, hasNodeHandler, hasNodeReference, hasNodeReferenceChildNodes, hasNodeReferenceChildNodes, hasNodeReferenceId, hasNodeReferenceId, hasSingleTextChild, hasTokenName, hasTokenValue, indexOf, isEmpty, iterator, jjtAccept, jjtAddChild, jjtClose, jjtGetChild, jjtGetNumChildren, jjtGetParent, jjtOpen, jjtSetParent, lastIndexOf, lastTokenName, lastTokenName, listIterator, listIterator, memberElement, newChildren, newNode, newNode, newNode, newNode, newNode, newNode, newNode, newNodeReferenceAttribute, onNodeReferenceChildHasChanged, onNodeReferenceHasChanged, printXML, printXML, removeAll, removeAttribute, removeChild, removeChild, removeNodeReference, replace, retainAll, set, setHandler, setMemberChild, setMemberChild, setMemberChild, setMemberList, setMemberListChild, setMemberOption, setMemberOption, setMemberOption, setMemberValue, setMemberValue, setMemberValue, setNodeReference, setNodeReference, setNodeReference, setOption, setOption, setOption, setOption, setTokenName, setTokenValue, size, strSingleTextChild, subList, toArray, toArray, toString, toString, toXML, toXML
 
Methods inherited from interface org.dom4j.Element
add, add, add, add, add, addAttribute, addAttribute, addCDATA, addComment, addEntity, additionalNamespaces, addNamespace, addProcessingInstruction, addProcessingInstruction, addText, attribute, attribute, attribute, attributeCount, attributeIterator, attributes, attributeValue, attributeValue, attributeValue, attributeValue, createCopy, createCopy, createCopy, declaredNamespaces, element, element, elementIterator, elementIterator, elementIterator, elements, elements, elements, elementText, elementText, elementTextTrim, elementTextTrim, getData, getNamespace, getNamespaceForPrefix, getNamespaceForURI, getNamespacePrefix, getNamespaceURI, getQName, getQName, getQualifiedName, getStringValue, getText, getTextTrim, getXPathResult, hasMixedContent, isRootElement, isTextOnly, remove, remove, remove, remove, remove, setAttributes, setAttributeValue, setAttributeValue, setData, setQName
 
Methods inherited from interface org.dom4j.Branch
add, add, add, add, addElement, addElement, addElement, appendContent, clearContent, content, elementByID, indexOf, node, nodeCount, nodeIterator, normalize, processingInstruction, processingInstructions, processingInstructions, remove, remove, remove, remove, removeProcessingInstruction, setContent, setProcessingInstructions
 
Methods inherited from interface org.dom4j.Node
accept, asXML, asXPathResult, clone, createXPath, detach, getDocument, getName, getNodeType, getNodeTypeName, getParent, getPath, getPath, getUniquePath, getUniquePath, hasContent, isReadOnly, matches, numberValueOf, selectNodes, selectNodes, selectNodes, selectObject, selectSingleNode, setDocument, setName, setParent, setText, supportsParent, valueOf, write
 
Methods inherited from interface smacs.util.listen.GetName
getName
 

Field Detail

log

protected static final Logger log
Constructor Detail

DbSchemaTableNode

public DbSchemaTableNode(SqlTableReferenceQ table)

DbSchemaTableNode

public DbSchemaTableNode(String tablename,
                         String schemaname)

DbSchemaTableNode

public DbSchemaTableNode(TableQName table)

DbSchemaTableNode

public DbSchemaTableNode(SmacsFixNodeLater later)
Method Detail

setTableName

public void setTableName(String tablename)

getTableName

public String getTableName()
Description copied from interface: DbSchemaTable
the table name. As taken from the SqlTableReference

Specified by:
getTableName in interface DbSchemaTable

setTableSchemaName

public void setTableSchemaName(String schemaname)

getTableSchemaName

public String getTableSchemaName()
Description copied from interface: HasTableSchemaName
the table schema name.

Specified by:
getTableSchemaName in interface HasTableSchemaName

getTableSchemaBaseNameSpec

public String getTableSchemaBaseNameSpec()
Description copied from interface: HasTableSchemaName
a syntactic qualifier for the schema name part.

Specified by:
getTableSchemaBaseNameSpec in interface HasTableSchemaName

getTableSchemaNameSpec

public String getTableSchemaNameSpec()
Description copied from interface: HasTableSchemaNameSpec
any syntactic qualifier of the table schema name.

Specified by:
getTableSchemaNameSpec in interface HasTableSchemaNameSpec

getTableNameSpec

public String getTableNameSpec()

hasSchemaName

public String hasSchemaName()
Description copied from interface: DbSchemaTable
the schema name. @return null if not present

Specified by:
hasSchemaName in interface DbSchemaTable

hasParentTableList

public DbSchemaTableList hasParentTableList()

hasParentTableListName

public String hasParentTableListName()

addColumn

public void addColumn(DbSchemaColumn column)

addColumn

public void addColumn(SqlTableColumnQ column)

getColumnList

public List getColumnList()
Description copied from interface: DbSchemaTable
get the columns of this table as a list.

Specified by:
getColumnList in interface DbSchemaTable

hasColumn

public DbSchemaColumn hasColumn(String name)
Description copied from interface: DbSchemaTable
find column within table definition. @return null if not present.

Specified by:
hasColumn in interface DbSchemaTable

addForeignKey

public void addForeignKey(DbSchemaForeignKey constraint)

getForeignKeyList

public List getForeignKeyList()
Description copied from interface: DbSchemaTable
get the foreignkeys of this table as a list.

Specified by:
getForeignKeyList in interface DbSchemaTable

hasForeignKeyTo

public boolean hasForeignKeyTo(DbSchemaTableQName table)
Description copied from interface: DbSchemaTable
check foreign key assertion.

Specified by:
hasForeignKeyTo in interface DbSchemaTable

addUniqueFields

public void addUniqueFields(DbSchemaUniqueFields constraint)

getUniqueFieldsList

public List getUniqueFieldsList()

SMACS