org.odftoolkit.odfdom.dom.element.db
Class OdfKeyElement

java.lang.Object
  extended by org.apache.xerces.dom.NodeImpl
      extended by org.apache.xerces.dom.ChildNode
          extended by org.apache.xerces.dom.ParentNode
              extended by org.apache.xerces.dom.ElementImpl
                  extended by org.apache.xerces.dom.ElementNSImpl
                      extended by org.odftoolkit.odfdom.dom.element.OdfElement
                          extended by org.odftoolkit.odfdom.dom.element.db.OdfKeyElement
All Implemented Interfaces:
Serializable, Cloneable, Element, EventTarget, Node, NodeList, TypeInfo
Direct Known Subclasses:
OdfKey

public abstract class OdfKeyElement
extends OdfElement

DOM implementation of OpenDocument element db:key.

See Also:
Serialized Form

Field Summary
static OdfName ELEMENT_NAME
           
 
Fields inherited from class org.odftoolkit.odfdom.dom.element.OdfElement
mOdfDocument
 
Fields inherited from class org.apache.xerces.dom.ElementNSImpl
localName, namespaceURI
 
Fields inherited from class org.apache.xerces.dom.ElementImpl
attributes, name
 
Fields inherited from class org.apache.xerces.dom.ParentNode
firstChild, fNodeListCache, ownerDocument
 
Fields inherited from class org.apache.xerces.dom.ChildNode
nextSibling, previousSibling
 
Fields inherited from class org.apache.xerces.dom.NodeImpl
DOCUMENT_POSITION_CONTAINS, DOCUMENT_POSITION_DISCONNECTED, DOCUMENT_POSITION_FOLLOWING, DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC, DOCUMENT_POSITION_IS_CONTAINED, DOCUMENT_POSITION_PRECEDING, ELEMENT_DEFINITION_NODE, FIRSTCHILD, flags, HASSTRING, ID, IGNORABLEWS, NORMALIZED, OWNED, ownerNode, READONLY, SPECIFIED, SYNCCHILDREN, SYNCDATA, TREE_POSITION_ANCESTOR, TREE_POSITION_DESCENDANT, TREE_POSITION_DISCONNECTED, TREE_POSITION_EQUIVALENT, TREE_POSITION_FOLLOWING, TREE_POSITION_PRECEDING, TREE_POSITION_SAME_NODE
 
Fields inherited from interface org.w3c.dom.Node
ATTRIBUTE_NODE, CDATA_SECTION_NODE, COMMENT_NODE, DOCUMENT_FRAGMENT_NODE, DOCUMENT_NODE, DOCUMENT_POSITION_CONTAINED_BY, DOCUMENT_POSITION_CONTAINS, DOCUMENT_POSITION_DISCONNECTED, DOCUMENT_POSITION_FOLLOWING, DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC, DOCUMENT_POSITION_PRECEDING, DOCUMENT_TYPE_NODE, ELEMENT_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE, NOTATION_NODE, PROCESSING_INSTRUCTION_NODE, TEXT_NODE
 
Fields inherited from interface org.w3c.dom.TypeInfo
DERIVATION_EXTENSION, DERIVATION_LIST, DERIVATION_RESTRICTION, DERIVATION_UNION
 
Constructor Summary
OdfKeyElement(OdfFileDom aOwnerDoc)
          Create the instance of OdfKeyElement
 
Method Summary
 OdfKeyColumnsElement createKeyColumnsElement()
          Create child element db:key-columns.
 OdfDeleteRuleType getDeleteRule()
          Get value of attribute db:delete-rule.
 String getName()
          Get value of attribute db:name.
 OdfName getOdfName()
          Get the element name
 String getReferencedTableName()
          Get value of attribute db:referenced-table-name.
 OdfType getType()
          Get value of attribute db:type.
 OdfUpdateRuleType getUpdateRule()
          Get value of attribute db:update-rule.
 void init(OdfType type)
          Initialization of the mandatory attributes of OdfKeyElement
 void setDeleteRule(OdfDeleteRuleType deleteRule)
          Set value of attribute db:delete-rule.
 void setName(String name)
          Set value of attribute db:name.
 void setReferencedTableName(String referencedTableName)
          Set value of attribute db:referenced-table-name.
 void setType(OdfType type)
          Set value of attribute db:type.
 void setUpdateRule(OdfUpdateRuleType updateRule)
          Set value of attribute db:update-rule.
 
Methods inherited from class org.odftoolkit.odfdom.dom.element.OdfElement
cloneNode, equals, findFirstChildNode, findNextChildNode, findPreviousChildNode, getAncestorAs, getOdfAttribute, getParentAs, hasOdfAttribute, insertBefore, onInsertNode, onInsertNode, onRemoveNode, onRemoveNode, removeChild, replaceChild, setOdfAttribute, toString
 
Methods inherited from class org.apache.xerces.dom.ElementNSImpl
getBaseURI, getLocalName, getNamespaceURI, getPrefix, getTypeName, getTypeNamespace, isDerivedFrom, setPrefix, setType, setValues
 
Methods inherited from class org.apache.xerces.dom.ElementImpl
getAttribute, getAttributeNode, getAttributeNodeNS, getAttributeNS, getAttributes, getDefaultAttributes, getElementsByTagName, getElementsByTagNameNS, getNodeName, getNodeType, getSchemaTypeInfo, getTagName, getXercesAttribute, hasAttribute, hasAttributeNS, hasAttributes, isEqualNode, normalize, reconcileDefaultAttributes, removeAttribute, removeAttributeNode, removeAttributeNS, setAttribute, setAttributeNode, setAttributeNodeNS, setAttributeNS, setIdAttribute, setIdAttributeNode, setIdAttributeNS, setOwnerDocument, setReadOnly, setupDefaultAttributes, setXercesAttributeNode, synchronizeData
 
Methods inherited from class org.apache.xerces.dom.ParentNode
getChildNodes, getChildNodesUnoptimized, getFirstChild, getLastChild, getLength, getOwnerDocument, getTextContent, hasChildNodes, item, setTextContent, synchronizeChildren
 
Methods inherited from class org.apache.xerces.dom.ChildNode
getNextSibling, getParentNode, getPreviousSibling
 
Methods inherited from class org.apache.xerces.dom.NodeImpl
addEventListener, appendChild, changed, changes, compareDocumentPosition, compareTreePosition, dispatchEvent, getContainer, getFeature, getNodeNumber, getNodeValue, getReadOnly, getUserData, getUserData, getUserDataRecord, isDefaultNamespace, isSameNode, isSupported, lookupNamespaceURI, lookupPrefix, needsSyncChildren, removeEventListener, setNodeValue, setUserData, setUserData
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface org.w3c.dom.Node
appendChild, compareDocumentPosition, getChildNodes, getFeature, getFirstChild, getLastChild, getNextSibling, getNodeValue, getOwnerDocument, getParentNode, getPreviousSibling, getTextContent, getUserData, hasChildNodes, isDefaultNamespace, isSameNode, isSupported, lookupNamespaceURI, lookupPrefix, setNodeValue, setTextContent, setUserData
 

Field Detail

ELEMENT_NAME

public static final OdfName ELEMENT_NAME
Constructor Detail

OdfKeyElement

public OdfKeyElement(OdfFileDom aOwnerDoc)
Create the instance of OdfKeyElement

Parameters:
aOwnerDoc - The type is OdfFileDom
Method Detail

getOdfName

public OdfName getOdfName()
Get the element name

Specified by:
getOdfName in class OdfElement
Returns:
return the name of element db:key.

init

public void init(OdfType type)
Initialization of the mandatory attributes of OdfKeyElement

Parameters:
type - The mandatory attribute db:type"

getName

public String getName()
Get value of attribute db:name.

Returns:
return the attribute which type is String

setName

public void setName(String name)
Set value of attribute db:name.

Parameters:
name - the attribute's type is String

getType

public OdfType getType()
Get value of attribute db:type.

Returns:
return the attribute which type is OdfType

setType

public void setType(OdfType type)
Set value of attribute db:type.

Parameters:
type - the attribute's type is OdfType

getReferencedTableName

public String getReferencedTableName()
Get value of attribute db:referenced-table-name.

Returns:
return the attribute which type is String

setReferencedTableName

public void setReferencedTableName(String referencedTableName)
Set value of attribute db:referenced-table-name.

Parameters:
referencedTableName - the attribute's type is String

getUpdateRule

public OdfUpdateRuleType getUpdateRule()
Get value of attribute db:update-rule.

Returns:
return the attribute which type is OdfUpdateRuleType

setUpdateRule

public void setUpdateRule(OdfUpdateRuleType updateRule)
Set value of attribute db:update-rule.

Parameters:
updateRule - the attribute's type is OdfUpdateRuleType

getDeleteRule

public OdfDeleteRuleType getDeleteRule()
Get value of attribute db:delete-rule.

Returns:
return the attribute which type is OdfDeleteRuleType

setDeleteRule

public void setDeleteRule(OdfDeleteRuleType deleteRule)
Set value of attribute db:delete-rule.

Parameters:
deleteRule - the attribute's type is OdfDeleteRuleType

createKeyColumnsElement

public OdfKeyColumnsElement createKeyColumnsElement()
Create child element db:key-columns.

Returns:
return the element db:key-columns


Copyright © 2009. All Rights Reserved.