Libraries.Data.Formats.DocumentTypeDefinitionEntity Documentation

The DocumentTypeDefinitionEntity class represents an entity that has been parsed from a document type definition.

Example Code

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

// DTD Element example: <!ENTITY language "Quorum">
DocumentTypeDefinitionEntity MyDTDEntity                
MyDTDEntity:SetName("language")
MyDTDEntity:SetValue("Quorum")

text name = MyDTDEntity:GetName() // name will be "language"
text value = MyDTDEntity:GetValue() // value will be "Quorum"

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.
GetHashCode()This action gets the hash code for an object.
GetName()This action gets the entity name.
GetValue()This action gets the entity value.
SetName(text name)This action sets the entity name to the given text value.
SetSourceDirectory(text directory)This action sets the source directory for the document type definition.
SetValue(text value)This action gets the entity 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.

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.

GetName()

This action gets the entity name.

Example Code

use Libraries.Data.Formats
        DocumentTypeDefinitionEntity MyDTDEntity
        MyDTDEntity:SetName("language")
        text value = MyDTDEntity:GetName() // value will be "language"

Return

text: The value of the entity name.

GetValue()

This action gets the entity value.

Example Code

use Libraries.Data.Formats
        DocumentTypeDefinitionEntity MyDTDEntity
        MyDTDEntity:SetValue("Quorum")
        text value = MyDTDEntity:GetValue() // value will be "Quorum"

Return

text: The value of the entity value.

SetName(text name)

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

Example Code

use Libraries.Data.Formats
        DocumentTypeDefinitionEntity MyDTDEntity
        MyDTDEntity:SetName("language")

Parameters

SetSourceDirectory(text directory)

This action sets the source directory for the document type definition. If the DTD uses external sources, they need to be in this directory.

Example Code

use Libraries.Data.Formats
        
        DocumentTypeDefinitionEntity MyDTDEntity
        MyDTDEntity:SetSourceDirectory("C:\")
        MyDTDEntity:SetValue("SYSTEM " + quote:GetDoubleQuote() + "entity.dtd" + quote:GetDoubleQuote())

Parameters

SetValue(text value)

This action gets the entity value.

Example Code

use Libraries.Data.Formats
        DocumentTypeDefinitionEntity MyDTDEntity
        MyDTDEntity:SetValue("Quorum")
        //or
        MyDTDEntity:SetValue("SYSTEM " + quote:GetDoubleQuote() + "entity.dtd" + quote:GetDoubleQuote())

Parameters