be.SIRAPRISE.client

Class Tuple

java.lang.Object

be.SIRAPRISE.client.Tuple

Direct Known Subclasses:

Tuple

public class Tuple
extends java.lang.Object

Author:

erwin

Constructor Summary

Constructors

Constructor and Description
Tuple(Heading heading, java.util.Map<java.lang.String,ValueBuffer> attributeValueMap) Deprecated. - replace with Tuple(Map, Heading)
Tuple(Heading heading, TupleBuffer tupleBuffer) Creates the Tuple object
Tuple(java.util.Map<NameIdentifier,ValueBuffer> attributeValueMap, Heading heading) Creates the tuple

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
boolean	equalsTuple(Tuple obj) Checks if this tuple is equal to the given tuple.
java.lang.String	escapedValueText(NameIdentifier attributeName) Gets The attribute value for the named attribute, in escaped external format
java.lang.String	escapedValueText(java.lang.String attributeName) Deprecated. - replace with escapedValueText(NameIdentifier)
Heading	getHeading() Gets the heading that the Tuple conforms to
static java.lang.String	getPropositionText(java.lang.String predicateText, TupleBuffer tupleBuffer, Heading heading) Creates a textual proposition from a given predicate, given the attribute values held in the TupleBuffer.
TupleBuffer	getTupleBuffer() Gets tupleBuffer
int	hashCode() Since equals is overridden
MyReadOnlyMap<NameIdentifier,ValueBuffer>	identifierValueMap() Returns the Map holding the attribute values of this tuple
static java.lang.String	printBodyValueWithoutTypeNames(Tuple t) Gets the tuple body value in textual format (i.e.
static java.lang.String	printBodyValueXML(Tuple t) Gets the tuple body value in textual XML-style format (i.e.
java.lang.String	printEscapedBodyValueWithoutTypeNames() Gets the tuple body value in textual format (i.e.
static java.lang.String	printEscapedBodyValueWithTypeNames(Tuple t) Gets the tuple body value in textual format (i.e.
static java.lang.String	printEscapedValueWithoutTypeNames(Tuple t) Gets the tuple value in textual format (i.e.
static java.lang.String	printEscapedValueWithTypeNames(Tuple t) Gets the tuple value in textual format (i.e.
static java.lang.String	printValueWithoutTypeNames(Tuple abstractTuple) Gets the tuple value in textual format (i.e.
static java.lang.String	printValueWithTypeNames(Tuple abstractTuple) Gets the tuple value in textual format (i.e.
static java.lang.String	printValueXML(Tuple t) Gets the tuple value in textual XML-style format (i.e.
Relation	rvaValue(NameIdentifier attributeName) Gets The attribute value for a relation-valued attribute, as a Relation object
Relation	rvaValue(java.lang.String attributeName) Deprecated. - replace with rvaValue(NameIdentifier)
java.lang.String	toString()
Tuple	tvaValue(NameIdentifier attributeName) Gets The attribute value for a relation-valued attribute, as a Relation object
Tuple	tvaValue(java.lang.String attributeName) Deprecated. - replace with tvaValue(NameIdentifier)
ValueBuffer	valueBuffer(NameIdentifier attributeName) Returns the ValueBuffer holding the value of the given attributename in this tuple
ValueBuffer	valueBuffer(java.lang.String attributeName) Deprecated. - replace with valueBuffer(NameIdentifier)
MyReadOnlyMap<java.lang.String,ValueBuffer>	valueMap() Deprecated. - replace with identifierValueMap()
java.lang.String	valueText(NameIdentifier attributeName) Returns the external representation of the value of the given attributename in this tuple, using the default possrep of the attribute's type
java.lang.String	valueText(java.lang.String attributeName) Deprecated. - replace with valueText(NameIdentifier)

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Tuple

@Deprecated
public Tuple(Heading heading,
                         java.util.Map<java.lang.String,ValueBuffer> attributeValueMap)

Deprecated. - replace with Tuple(Map, Heading)

Creates the tuple

Parameters:

heading - the heading that the Tuple conforms to

attributeValueMap - the map holding the tuple's attribute values

Tuple

public Tuple(java.util.Map<NameIdentifier,ValueBuffer> attributeValueMap,
             Heading heading)

Creates the tuple

Parameters:

heading - the heading that the Tuple conforms to

attributeValueMap - the map holding the tuple's attribute values

Tuple

public Tuple(Heading heading,
             TupleBuffer tupleBuffer)

Creates the Tuple object

Parameters:

heading - the heading that the Tuple conforms to

tupleBuffer - the buffer holding the tuple value

Method Detail

printBodyValueWithoutTypeNames

public static final java.lang.String printBodyValueWithoutTypeNames(Tuple t)

Gets the tuple body value in textual format (i.e. attr1(value1)attr2(value2) with value1, value2, ... NOT naming the type (i.e. 1 instead of INT(1))

Parameters:

t - The tuple to be printed

Returns:

the tuple body value in textual format (i.e. attr1(value1)attr2(value2) with value1, value2, ... NOT naming the type (i.e. 1 instead of INT(1))

printBodyValueXML

public static final java.lang.String printBodyValueXML(Tuple t)

Gets the tuple body value in textual XML-style format (i.e. <attr1>value1</attr1> <attr2>value2</attr2>)

Parameters:

t - The tuple to be rendered to Text

Returns:

The tuple body value in textual XML-style format (i.e. <attr1>value1</attr1> <attr2>value2</attr2>)

printEscapedBodyValueWithTypeNames

public static final java.lang.String printEscapedBodyValueWithTypeNames(Tuple t)

Gets the tuple body value in textual format (i.e. attr1(value1)attr2(value2), INCLUDING escape processing for the ()\ characters of the metalanguage that appear in a printed value

Parameters:

t - The tuple to be rendered to Text

Returns:

the tuple body value in textual format (i.e. attr1(value1)attr2(value2), INCLUDING escape processing for the ()\ characters of the metalanguage that appear in a printed value

printEscapedValueWithoutTypeNames

public static final java.lang.String printEscapedValueWithoutTypeNames(Tuple t)

Gets the tuple value in textual format (i.e. TUPLE(attr1(value1)attr2(value2)) INCLUDING escape processing for the ()\ characters of the metalanguage

Parameters:

t - the tuple to be rendered to text

Returns:

the tuple value in textual format (i.e. TUPLE(attr1(value1)attr2(value2)) INCLUDING escape processing for the ()\ characters of the metalanguage

printEscapedValueWithTypeNames

public static final java.lang.String printEscapedValueWithTypeNames(Tuple t)

Gets the tuple value in textual format (i.e. TUPLE(attr1(value1)attr2(value2)) INCLUDING escape processing for the ()\ characters of the metalanguage

Parameters:

t - The tuple to be rendered to Text

Returns:

the tuple value in textual format (i.e. TUPLE(attr1(value1)attr2(value2)) INCLUDING escape processing for the ()\ characters of the metalanguage

printValueWithoutTypeNames

public static final java.lang.String printValueWithoutTypeNames(Tuple abstractTuple)

Gets the tuple value in textual format (i.e. TUPLE(attr1(value1)attr2(value2)) with value1, value2, ... NOT naming the type (i.e. 1 instead of INT(1))

Parameters:

abstractTuple - The tuple to be rendered to text

Returns:

the tuple value in textual format (i.e. TUPLE(attr1(value1)attr2(value2)) with value1, value2, ... NOT naming the type (i.e. 1 instead of INT(1))

printValueWithTypeNames

public static java.lang.String printValueWithTypeNames(Tuple abstractTuple)

Gets the tuple value in textual format (i.e. TUPLE(attr1(value1)attr2(value2)) with value1, value2, ... NOT naming the type (i.e. 1 instead of INT(1))

Parameters:

abstractTuple - The tuple to be rendered in print

Returns:

the tuple value in textual format (i.e. TUPLE(attr1(value1)attr2(value2)) with value1, value2, ... NOT naming the type (i.e. 1 instead of INT(1))

printValueXML

public static final java.lang.String printValueXML(Tuple t)

Gets the tuple value in textual XML-style format (i.e. <Tuple><attr1>value1 </attr1> <attr2>value2 </attr2> </Tuple>

Parameters:

t - The tuple to be rendered in an XML text format

Returns:

The tuple value in textual XML-style format (i.e. <Tuple><attr1>value1 </attr1> <attr2>value2 </attr2> </Tuple>

equals

public final boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

equalsTuple

public final boolean equalsTuple(Tuple obj)

Checks if this tuple is equal to the given tuple. Two tuples are equal if and only if both their headings and their value mappings are equal.

Parameters:

obj - the tuple to compare to this one

Returns:

true if the given tuple is equal to this one

escapedValueText

@Deprecated
public final java.lang.String escapedValueText(java.lang.String attributeName)

Deprecated. - replace with escapedValueText(NameIdentifier)

Gets The attribute value for the named attribute, in escaped external format

Parameters:

attributeName - The name of the attribute whose value is to be obtained

Returns:

The attribute value of the named attribute in this tuple, including the SIRA_PRISE escape sequences

escapedValueText

public final java.lang.String escapedValueText(NameIdentifier attributeName)

Gets The attribute value for the named attribute, in escaped external format

Parameters:

attributeName - The name of the attribute whose value is to be obtained

Returns:

The attribute value of the named attribute in this tuple, including the SIRA_PRISE escape sequences

getHeading

public final Heading getHeading()

Gets the heading that the Tuple conforms to

Returns:

the heading that the Tuple conforms to

getTupleBuffer

public final TupleBuffer getTupleBuffer()

Gets tupleBuffer

Returns:

tupleBuffer.

hashCode

public final int hashCode()

Since equals is overridden

Overrides:

hashCode in class java.lang.Object

printEscapedBodyValueWithoutTypeNames

public final java.lang.String printEscapedBodyValueWithoutTypeNames()

Gets the tuple body value in textual format (i.e. attr1(value1)attr2(value2), INCLUDING escape processing for the ()\ characters of the metalanguage that appear in a printed value

Returns:

the tuple body value in textual format (i.e. attr1(value1)attr2(value2), INCLUDING escape processing for the ()\ characters of the metalanguage that appear in a printed value

rvaValue

@Deprecated
public final Relation rvaValue(java.lang.String attributeName)

Deprecated. - replace with rvaValue(NameIdentifier)

Gets The attribute value for a relation-valued attribute, as a Relation object

Parameters:

attributeName - The name of the attribute whose value is to be obtained. This attribute must be declared nonscalar in the heading.

Returns:

The attribute value

rvaValue

public final Relation rvaValue(NameIdentifier attributeName)

Gets The attribute value for a relation-valued attribute, as a Relation object

Parameters:

attributeName - The name of the attribute whose value is to be obtained. This attribute must be declared nonscalar in the heading.

Returns:

The attribute value

toString

public final java.lang.String toString()

Overrides:

toString in class java.lang.Object

tvaValue

@Deprecated
public final Tuple tvaValue(java.lang.String attributeName)

Deprecated. - replace with tvaValue(NameIdentifier)

Gets The attribute value for a relation-valued attribute, as a Relation object

Parameters:

attributeName - The name of the attribute whose value is to be obtained. This attribute must be declared nonscalar in the heading.

Returns:

The attribute value

tvaValue

public final Tuple tvaValue(NameIdentifier attributeName)

Gets The attribute value for a relation-valued attribute, as a Relation object

Parameters:

attributeName - The name of the attribute whose value is to be obtained. This attribute must be declared nonscalar in the heading.

Returns:

The attribute value

valueBuffer

@Deprecated
public final ValueBuffer valueBuffer(java.lang.String attributeName)

Deprecated. - replace with valueBuffer(NameIdentifier)

Returns the ValueBuffer holding the value of the given attributename in this tuple

Parameters:

attributeName - The name of the attribute, the value of which is to be returned in external representation

Returns:

the external representation of the value of the given attributename in this tuple, using the default possrep of the attribute's type

valueBuffer

public final ValueBuffer valueBuffer(NameIdentifier attributeName)

Returns the ValueBuffer holding the value of the given attributename in this tuple

Parameters:

attributeName - The name of the attribute, the value of which is to be returned in external representation

Returns:

the external representation of the value of the given attributename in this tuple, using the default possrep of the attribute's type

valueMap

@Deprecated
public final MyReadOnlyMap<java.lang.String,ValueBuffer> valueMap()

Deprecated. - replace with identifierValueMap()

Returns the Map holding the attribute values of this tuple

Returns:

the Map holding the attribute values of this tuple

identifierValueMap

public final MyReadOnlyMap<NameIdentifier,ValueBuffer> identifierValueMap()

Returns the Map holding the attribute values of this tuple

Returns:

the Map holding the attribute values of this tuple

valueText

@Deprecated
public final java.lang.String valueText(java.lang.String attributeName)

Deprecated. - replace with valueText(NameIdentifier)

Returns the external representation of the value of the given attributename in this tuple, using the default possrep of the attribute's type

Parameters:

attributeName - The name of the attribute, the value of which is to be returned in external representation

Returns:

the external representation of the value of the given attributename in this tuple, using the default possrep of the attribute's type

valueText

public final java.lang.String valueText(NameIdentifier attributeName)

Returns the external representation of the value of the given attributename in this tuple, using the default possrep of the attribute's type

Parameters:

attributeName - The name of the attribute, the value of which is to be returned in external representation

Returns:

the external representation of the value of the given attributename in this tuple, using the default possrep of the attribute's type

getPropositionText

public static java.lang.String getPropositionText(java.lang.String predicateText,
                                                  TupleBuffer tupleBuffer,
                                                  Heading heading)

Creates a textual proposition from a given predicate, given the attribute values held in the TupleBuffer. Appearances in the predicate of an attribute name of the TupleBuffer, enclosed in '§' characters, will be replaced by (the external representation of) the actual value held for that attribute in the TupleBuffer. The external representation is created using the Type Declaration held for the attribute in the given Heading object.

Parameters:

predicateText - A predicate text, in which the references to 'free' variables appear as '§' characters enclosing an attribute name

tupleBuffer - holds the attribute values to instantiate the free variables of the predicate with

heading - The heading that the tupleconforms to

Returns:

a textual proposition from a given predicate, given the attribute values held in the TupleBuffer