be.SIRAPRISE.client
Interface Tuple
- All Known Implementing Classes:
- AbstractTuple, ClientTuple
public interface Tuple
A Tuple is a set of named attribute values. Values can thus be "read" from the tuple by providing the attribute name.
- Author:
- Erwin Smout
Method Summary |
java.lang.String |
escapedValue(java.lang.String attributeName)
Gets The attribute value for the named attribute |
Heading |
getHeading()
Gets the heading that the Tuple conforms to |
java.lang.String |
printBodyValueWithoutTypeNames()
Gets the tuple body value in textual format (i.e. attr1(value1)attr2(value2) with value1, value2, ... |
java.lang.String |
printBodyValueWithTypeNames()
Gets the tuple body value in textual format (i.e. attr1(value1)attr2(value2) with value1, value2, ... |
java.lang.String |
printBodyValueXML()
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. attr1(value1)attr2(value2), INCLUDING escape processing for the ()\ characters of the metalanguage that appear in a printed value |
java.lang.String |
printEscapedBodyValueWithTypeNames()
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 |
java.lang.String |
printValueEscapedWithoutTypeNames()
Gets the tuple value in textual format (i.e. |
java.lang.String |
printValueEscapedWithTypeNames()
Gets the tuple value in textual format (i.e. |
java.lang.String |
printValueWithoutTypeNames()
Gets the tuple value in textual format (i.e. |
java.lang.String |
printValueWithTypeNames()
Gets the tuple value in textual format (i.e. |
java.lang.String |
printValueXML()
Gets the tuple value in textual XML-style format (i.e. |
AbstractRelation |
rvaValue(java.lang.String attributeName)
Gets The attribute value for a relation-valued attribute, as a Relation object |
java.lang.String |
value(java.lang.String attributeName)
Gets The attribute value for the named attribute |
IntersectableMap<?,?> |
values()
Gets the map of attribute values |
escapedValue
java.lang.String escapedValue(java.lang.String attributeName)
- Gets The attribute value for the named attribute
- Parameters:
attributeName
- The name of the attribute whose value is to be obtained
- Returns:
- The attribute value including the SIRA_PRISE escape sequences
getHeading
Heading getHeading()
- Gets the heading that the Tuple conforms to
- Returns:
- the heading that the Tuple conforms to
printBodyValueWithoutTypeNames
java.lang.String printBodyValueWithoutTypeNames()
- 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))
- 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))
printBodyValueWithTypeNames
java.lang.String printBodyValueWithTypeNames()
- 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))
- 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
java.lang.String printBodyValueXML()
- Gets the tuple body value in textual XML-style format (i.e. value1 value2 )
- Returns:
- The tuple body value in textual XML-style format (i.e. value1 value2 )
printEscapedBodyValueWithoutTypeNames
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
printEscapedBodyValueWithTypeNames
java.lang.String printEscapedBodyValueWithTypeNames()
- 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
printValueEscapedWithoutTypeNames
java.lang.String printValueEscapedWithoutTypeNames()
- Gets the tuple value in textual format (i.e. TUPLE(attr1(value1)attr2(value2)) INCLUDING escape processing for the ()\ characters of the metalanguage
- Returns:
- the tuple value in textual format (i.e. TUPLE(attr1(value1)attr2(value2)) INCLUDING escape processing for the ()\ characters of the metalanguage
printValueEscapedWithTypeNames
java.lang.String printValueEscapedWithTypeNames()
- Gets the tuple value in textual format (i.e. TUPLE(attr1(value1)attr2(value2)) INCLUDING escape processing for the ()\ characters of the metalanguage
- Returns:
- the tuple value in textual format (i.e. TUPLE(attr1(value1)attr2(value2)) INCLUDING escape processing for the ()\ characters of the metalanguage
printValueWithoutTypeNames
java.lang.String printValueWithoutTypeNames()
- 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))
- 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
java.lang.String printValueWithTypeNames()
- 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))
- 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
java.lang.String printValueXML()
- Gets the tuple value in textual XML-style format (i.e. value1 value2
- Returns:
- The tuple value in textual XML-style format (i.e. value1 value2
rvaValue
AbstractRelation rvaValue(java.lang.String 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
value
java.lang.String value(java.lang.String attributeName)
- Gets The attribute value for the named attribute
- Parameters:
attributeName
- The name of the attribute whose value is to be obtained
- Returns:
- The attribute value with SIRA_PRISE escape sequences removed
values
IntersectableMap<?,?> values()
- Gets the map of attribute values
- Returns:
- the map of attribute values