Libraries.Data.Formats.AttributesImplementation Documentation

The AttributesImplementation class is used to represent an array of Attributes that have been Parsed from an XML document. Like the Array class, the location always starts at 0, this means the first item in the attributes is at location 0, the second is at location 1, etc.

Example Code

use Libraries.Data.Formats

Attribute data
data:name = "day"
data:value = "01"
AttributesImplementation myAttributes
myAttributes:Add(data)
text value = myAttributes:GetName(0)

Inherits from: Libraries.Language.Object, Libraries.Data.Formats.Attributes

Actions Documentation

Add(Libraries.Data.Formats.Attribute attribute)

This action adds a value at the end of the array of attributes.

Parameters

Example

use Libraries.Data.Formats
Attribute data
data:name = "day"
data:value = "01"
AttributesImplementation myAttributes
myAttributes:Add(data)

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)

Empty()

This action empty's the array of attributes, clearing out all of the items contained within it.

Example

use Libraries.Data.Formats
AttributesImplementation myAttributes
Attribute firstName
Attribute lastName
Attribute dob
myAttributes:Add(firstName)
myAttributes:Add(lastName)
myAttributes:Add(dob)
myAttributes:Empty()

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

This action gets the name of the Attribute at the given location in the indexed array of Attributes.

Parameters

  • integer index: The index or location of the wanted attribute.

Return

text: The name of the attribute at the indexed location.

Example

use Libraries.Data.Formats
AttributesImplementation myAttributes
Attribute data
data:name = "day"
myAttributes:Add(data)
text value = myAttributes:GetName(0)

GetSize()

This action gets the size of the array of Attributes.

Return

integer:

Example

use Libraries.Data.Formats
AttributesImplementation myAttributes
integer size = myAttributes:GetSize()

GetValue(integer index)

This action gets the value of the Attribute at the given location in the indexed array of Attributes.

Parameters

  • integer index: The index or location of the wanted attribute.

Return

text: The value of the attribute at the indexed location.

Example

use Libraries.Data.Formats
AttributesImplementation myAttributes
Attribute data
data:value = "01"
myAttributes:Add(data)
text value = myAttributes:GetValue(0)