Package org.odftoolkit.odfdom.dom.element.db

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:

  • 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