Class DbKeyElement

java.lang.Object

org.apache.xerces.dom.NodeImpl

org.apache.xerces.dom.ChildNode

org.apache.xerces.dom.ParentNode

org.apache.xerces.dom.ElementImpl

org.apache.xerces.dom.ElementNSImpl

org.odftoolkit.odfdom.pkg.OdfElement

org.odftoolkit.odfdom.dom.element.db.DbKeyElement

All Implemented Interfaces:

Serializable, Cloneable, Element, ElementTraversal, EventTarget, Node, NodeList, TypeInfo

public class DbKeyElement
extends OdfElement

DOM implementation of OpenDocument element <db:key>.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final OdfName	ELEMENT_NAME

Fields inherited from class ElementNSImpl

localName, namespaceURI

Fields inherited from class ElementImpl

attributes, name

Fields inherited from class ParentNode

firstChild, fNodeListCache, ownerDocument

Fields inherited from class ChildNode

nextSibling, previousSibling

Fields inherited from class 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 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 TypeInfo

DERIVATION_EXTENSION, DERIVATION_LIST, DERIVATION_RESTRICTION, DERIVATION_UNION

Constructor Summary

Constructors

Constructor	Description
DbKeyElement(OdfFileDom ownerDoc)	Create the instance of DbKeyElement

Method Summary

Modifier and Type	Method	Description
void	accept(ElementVisitor visitor)	Accept an visitor instance to allow the visitor to do some operations.
String	getDbDeleteRuleAttribute()	Receives the value of the ODFDOM attribute representation DbDeleteRuleAttribute , See @db:delete-rule
String	getDbNameAttribute()	Receives the value of the ODFDOM attribute representation DbNameAttribute , See @db:name
String	getDbReferencedTableNameAttribute()	Receives the value of the ODFDOM attribute representation DbReferencedTableNameAttribute , See @db:referenced-table-name
String	getDbTypeAttribute()	Receives the value of the ODFDOM attribute representation DbTypeAttribute , See @db:type
String	getDbUpdateRuleAttribute()	Receives the value of the ODFDOM attribute representation DbUpdateRuleAttribute , See @db:update-rule
OdfName	getOdfName()	Get the element name
DbKeyColumnsElement	newDbKeyColumnsElement()	Create child element <db:key-columns>.
void	setDbDeleteRuleAttribute(String dbDeleteRuleValue)	Sets the value of ODFDOM attribute representation DbDeleteRuleAttribute , See @db:delete-rule
void	setDbNameAttribute(String dbNameValue)	Sets the value of ODFDOM attribute representation DbNameAttribute , See @db:name
void	setDbReferencedTableNameAttribute(String dbReferencedTableNameValue)	Sets the value of ODFDOM attribute representation DbReferencedTableNameAttribute , See @db:referenced-table-name
void	setDbTypeAttribute(String dbTypeValue)	Sets the value of ODFDOM attribute representation DbTypeAttribute , See @db:type
void	setDbUpdateRuleAttribute(String dbUpdateRuleValue)	Sets the value of ODFDOM attribute representation DbUpdateRuleAttribute , See @db:update-rule

Methods inherited from class OdfElement

appendChild, appendUsingWhitespaceHandling, cloneElement, cloneNode, cloneNode, cloneNode, cloneOdfElement, componentSize, copyAttributes, countChildComponents, countDescendantComponents, countPrecedingSiblingElements, delete, equals, findFirstChildNode, findNextChildNode, findPreviousChildNode, getAncestorAs, getChildElement, getChildElement, getComponent, getComponentRoot, getFirstChildElement, getLastChildElement, getNextSiblingElement, getOdfAttribute, getOdfAttribute, getOdfAttribute, getOdfAttributeValue, getParentAs, getPreviousSiblingElement, getRepetition, getTextContent, hasAncestor, hasOdfAttribute, ignoredComponent, insert, insert, insertBefore, isComponentRoot, isIgnoredElement, isIgnoredElement, isRepeatable, markAsComponentRoot, markText, moveChildrenTo, onInsertNode, onInsertNode, onRemoveNode, onRemoveNode, receiveNode, receiveNode, removeChild, removeContent, removeSingleElement, replaceChild, selfAndDescendantTextIgnoredAsComponent, setComponent, setOdfAttribute, setOdfAttribute, setOdfAttributeValue, setRepetition, split, toString

Methods inherited from class ElementNSImpl

getLocalName, getNamespaceURI, getPrefix, getTypeName, getTypeNamespace, getXMLBaseAttribute, isDerivedFrom, setPrefix, setType

Methods inherited from class ElementImpl

getAttribute, getAttributeNode, getAttributeNodeNS, getAttributeNS, getAttributes, getBaseURI, getChildElementCount, getDefaultAttributes, getElementsByTagName, getElementsByTagNameNS, getFirstElementChild, getLastElementChild, getNextElementSibling, getNodeName, getNodeType, getPreviousElementSibling, 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 ParentNode

getChildNodes, getChildNodesUnoptimized, getFirstChild, getLastChild, getLength, getOwnerDocument, hasChildNodes, item, setTextContent, synchronizeChildren

Methods inherited from class ChildNode

getNextSibling, getParentNode, getPreviousSibling

Methods inherited from class NodeImpl

addEventListener, 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 Object

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

Methods inherited from interface Node

compareDocumentPosition, getChildNodes, getFeature, getFirstChild, getLastChild, getNextSibling, getNodeValue, getOwnerDocument, getParentNode, getPreviousSibling, getUserData, hasChildNodes, isDefaultNamespace, isSameNode, isSupported, lookupNamespaceURI, lookupPrefix, setNodeValue, setTextContent, setUserData

Field Details

ELEMENT_NAME

public static final OdfName ELEMENT_NAME

Constructor Details

DbKeyElement

public DbKeyElement(OdfFileDom ownerDoc)

Create the instance of DbKeyElement

Parameters:

ownerDoc - The type is OdfFileDom

Method Details

getOdfName

public OdfName getOdfName()

Get the element name

Specified by:

getOdfName in class OdfElement

Returns:

return OdfName the name of element <db:key>.

getDbDeleteRuleAttribute

public String getDbDeleteRuleAttribute()

Receives the value of the ODFDOM attribute representation DbDeleteRuleAttribute , See @db:delete-rule

Returns:

- the String , the value or null, if the attribute is not set and no default value defined.

setDbDeleteRuleAttribute

public void setDbDeleteRuleAttribute(String dbDeleteRuleValue)

Sets the value of ODFDOM attribute representation DbDeleteRuleAttribute , See @db:delete-rule

Parameters:

dbDeleteRuleValue - The type is String

getDbNameAttribute

public String getDbNameAttribute()

Receives the value of the ODFDOM attribute representation DbNameAttribute , See @db:name

Returns:

- the String , the value or null, if the attribute is not set and no default value defined.

setDbNameAttribute

public void setDbNameAttribute(String dbNameValue)

Sets the value of ODFDOM attribute representation DbNameAttribute , See @db:name

Parameters:

dbNameValue - The type is String

getDbReferencedTableNameAttribute

public String getDbReferencedTableNameAttribute()

Receives the value of the ODFDOM attribute representation DbReferencedTableNameAttribute , See @db:referenced-table-name

Returns:

- the String , the value or null, if the attribute is not set and no default value defined.

setDbReferencedTableNameAttribute

public void setDbReferencedTableNameAttribute(String dbReferencedTableNameValue)

Sets the value of ODFDOM attribute representation DbReferencedTableNameAttribute , See @db:referenced-table-name

Parameters:

dbReferencedTableNameValue - The type is String

getDbTypeAttribute

public String getDbTypeAttribute()

Receives the value of the ODFDOM attribute representation DbTypeAttribute , See @db:type

Attribute is mandatory.

Returns:

- the String , the value or null, if the attribute is not set and no default value defined.

setDbTypeAttribute

public void setDbTypeAttribute(String dbTypeValue)

Sets the value of ODFDOM attribute representation DbTypeAttribute , See @db:type

Parameters:

dbTypeValue - The type is String

getDbUpdateRuleAttribute

public String getDbUpdateRuleAttribute()

Receives the value of the ODFDOM attribute representation DbUpdateRuleAttribute , See @db:update-rule

Returns:

- the String , the value or null, if the attribute is not set and no default value defined.

setDbUpdateRuleAttribute

public void setDbUpdateRuleAttribute(String dbUpdateRuleValue)

Sets the value of ODFDOM attribute representation DbUpdateRuleAttribute , See @db:update-rule

Parameters:

dbUpdateRuleValue - The type is String

newDbKeyColumnsElement

public DbKeyColumnsElement newDbKeyColumnsElement()

Create child element <db:key-columns>.

Child element was added in ODF 1.2

Child element is mandatory.

Returns:

the element <db:key-columns>

accept

public void accept(ElementVisitor visitor)

Accept an visitor instance to allow the visitor to do some operations. Refer to visitor design pattern to get a better understanding.

Overrides:

accept in class OdfElement

Parameters:

visitor - an instance of DefaultElementVisitor