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
Actions | Description |
---|---|
Compare(Libraries.Language.Object object) | This action compares two object hash codes and returns an integer. |
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 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.
Example Code
Object o
Object t
integer result = o:Compare(t) //1 (larger), 0 (equal), or -1 (smaller)
Parameters
- Libraries.Language.Object: The object to compare to.
Return
integer: 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
- Libraries.Language.Object: The to be compared.
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
- text name: The value to set the entity name to.
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
- text directory: The directory of external sources.
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())