Libraries.Data.Formats.DocumentTypeDefinitionElement Documentation

The DocumentTypeDefinitionElement class represents an element that has been parsed from a document type definition.

Example Code

use Libraries.System.File
use Libraries.Data.Formats

// DTD Element example: <!ELEMENT note (to,from,heading,body)>
DocumentTypeDefinitionElement MyDTDElement                  
MyDTDElement:SetElementName("note")
MyDTDElement:SetCategory("(to,from,heading,body)")

boolean pcdata = MyDTDElement:IsParsedCharacterData() // pcdata will be false
boolean empty = MyDTDElement:IsEmptyElement() // empty will be false
boolean any = MyDTDElement:IsAnyContentElement() // any will be false
boolean children = MyDTDElement:HasChildren() // children will be true

Inherits from: Libraries.Language.Object

Actions Documentation

Compare(Libraries.Language.Object object)

This action compares two object hash codes and returns an integer. The result is larger if this hash code is larger than the object passed as a parameter, smaller, or equal. In this case, -1 means smaller, 0 means equal, and 1 means larger. This action was changed in Quorum 7 to return an integer, instead of a CompareResult object, because the previous implementation was causing efficiency issues.

Parameters

Return

integer: The Compare result, Smaller, Equal, or Larger.

Example

Object o
Object t
integer result = o:Compare(t) //1 (larger), 0 (equal), or -1 (smaller)

Equals(Libraries.Language.Object object)

This action determines if two objects are equal based on their hash code values.

Parameters

Return

boolean: True if the hash codes are equal and false if they are not equal.

Example

use Libraries.Language.Object
use Libraries.Language.Types.Text
Object o
Text t
boolean result = o:Equals(t)

GetChildren()

This action gets the element name.

Return

text: The value of the element name.

Example

use Libraries.Data.Formats
DocumentTypeDefinitionElement MyDTDElement                  
MyDTDElement:SetCategory("(to,from,heading,body)")
if MyDTDElement:HasChildren()
   text children = MyDTDElement:GetChildren() // children will be (to,from,heading,body)
end

GetElementName()

This action gets the element name.

Return

text: The value of the element name.

Example

use Libraries.Data.Formats
DocumentTypeDefinitionElement MyDTDElement                  
MyDTDElement:SetElementName("note")
text value = MyDTDElement:GetElementName() // value will be "note"

GetHashCode()

This action gets the hash code for an object.

Return

integer: The integer hash code of the object.

Example

Object o
integer hash = o:GetHashCode()

HasChildren()

This action determines if the category of the element has children elements.

Return

boolean: True if the category of the element has children elements and false if it is not.

Example

use Libraries.Data.Formats
DocumentTypeDefinitionElement MyDTDElement
MyDTDElement:SetCategory("(to,from,heading,body)")
boolean value = MyDTDElement:HasChildren() // value will be true

IsAnyContentElement()

This action determines if the category of the element is any content.

Return

boolean: True if the category of the element is any content and false if it is not.

Example

use Libraries.Data.Formats
DocumentTypeDefinitionElement MyDTDElement                  
MyDTDElement:SetCategory("ANY")
boolean value = MyDTDElement:IsAnyContentElement() // value will be true

IsEmptyElement()

This action determines if the category of the element is empty.

Return

boolean: True if the category of the element is empty and false if it is not.

Example

use Libraries.Data.Formats
DocumentTypeDefinitionElement MyDTDElement                  
MyDTDElement:SetCategory("EMPTY")
boolean value = MyDTDElement:IsEmptyElement() // value will be true

IsParsedCharacterData()

This action determines if the category of the element is parsed character data.

Return

boolean: True if the category of the element is parsed character data and false if it is not.

Example

use Libraries.Data.Formats
DocumentTypeDefinitionElement MyDTDElement
MyDTDElement:SetCategory("(#PCDATA)")
boolean value = MyDTDElement:HasParsedCharacterData() // value will be true

SetCategory(text category)

This action sets the element category to the given text value. It will check to see if the value is empty, any, PCDATA, or a list of children.

Parameters

  • text category

Example

use Libraries.Data.Formats
DocumentTypeDefinitionElement MyDTDElement                  
MyDTDElement:SetCategory("(to,from,heading,body)")
// or
MyDTDElement:SetCategory("EMPTY")

SetElementName(text name)

This action sets the element name to the given text value.

Parameters

  • text name: The value to set the element name to.

Example

use Libraries.Data.Formats
DocumentTypeDefinitionElement MyDTDElement                  
MyDTDElement:SetElementName("note")