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

Summary

Actions Summary Table

ActionsDescription
Compare(Libraries.Language.Object object)This action compares two object hash codes and returns a CompareResult.
Equals(Libraries.Language.Object object)This action determines if two objects are equal based on their hash code values.
GetChildren()This action gets the element name.
GetElementName()This action gets the element name.
GetHashCode()This action gets the hash code for an object.
HasChildren()This action determines if the category of the element has children elements.
IsAnyContentElement()This action determines if the category of the element is any content.
IsEmptyElement()This action determines if the category of the element is empty.
IsParsedCharacterData()This action determines if the category of the element is parsed character data.
SetCategory(text category)This action sets the element category to the given text value.
SetElementName(text name)This action sets the element name to the given text value.

Actions Documentation

Compare(Libraries.Language.Object object)

This action compares two object hash codes and returns a CompareResult. The compare result is either larger if this hash code is larger than the object passed as a parameter, smaller, or equal.

Example Code

use Libraries.Language.Support.CompareResult
        Object o
        Object t
        CompareResult result = o:Compare(t)

Parameters

Return

Libraries.Language.Support.CompareResult: The Compare result, Smaller, Equal, or Larger.

Equals(Libraries.Language.Object object)

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

Example Code

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

Parameters

Return

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

GetChildren()

This action gets the element name.

Example Code

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

Return

text: The value of the element name.

GetElementName()

This action gets the element name.

Example Code

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

Return

text: The value of the element name.

GetHashCode()

This action gets the hash code for an object.

Example Code

Object o
        integer hash = o:GetHashCode()

Return

integer: The integer hash code of the object.

HasChildren()

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

Example Code

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

Return

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

IsAnyContentElement()

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

Example Code

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

Return

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

IsEmptyElement()

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

Example Code

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

Return

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

IsParsedCharacterData()

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

Example Code

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

Return

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

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.

Example Code

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

Parameters

SetElementName(text name)

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

Example Code

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

Parameters