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

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)

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()

GetName()

This action gets the entity name.

Return

text: The value of the entity name.

Example

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

GetValue()

This action gets the entity value.

Return

text: The value of the entity value.

Example

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

SetName(text name)

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

Parameters

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

Example

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

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.

Parameters

  • text directory: The directory of external sources.

Example

use Libraries.Data.Formats

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

SetValue(text value)

This action gets the entity value.

Parameters

  • text value

Example

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