TupleContainer

java.lang.Object
- be.SIRAPRISE.client.TupleContainer

All Implemented Interfaces:

java.lang.Iterable<Tuple>

Direct Known Subclasses:

Relation, TupleContainer
```
public class TupleContainer
extends java.lang.Object
implements java.lang.Iterable<Tuple>
```
Author:

erwin

Constructor Summary

Constructors
Constructor and Description

TupleContainer(Heading heading, TupleCollectionBuffer tupleCollectionBuffer)
Creates the AbstractTupleContainer

Constructors
Constructor and Description
`TupleContainer(Heading heading, TupleCollectionBuffer tupleCollectionBuffer)` Creates the AbstractTupleContainer

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Heading`	`getHeading()` Gets The heading for tuple container.
`TupleCollectionBuffer`	`getTupleCollectionBuffer()` Gets tupleCollectionBuffer
`java.util.Iterator<Tuple>`	`iterator()` Gets an iterator over the tuples in the container
`java.lang.String`	`printBodyEscapedWithBodyHeaderWithTypeNames()` Gets the relation body in text
`java.lang.String`	`printBodyEscapedWithoutBodyHeaderWithoutTypeNames()` Gets the relation body in text EXCLUDING the BODY( ) container
`java.lang.String`	`printBodyEscapedWithoutBodyHeaderWithTypeNames()` Gets the relation body in text EXCLUDING the BODY( ) container
`java.lang.String`	`printBodyWithoutBodyHeaderWithoutTypeNames()` Gets the relation body in text EXCLUDING the BODY( ) container
`java.lang.String`	`printBodyWithoutBodyHeaderWithTypeNames()` Gets the relation body in text EXCLUDING the BODY( ) container
`java.lang.String`	`printBodyXMLWithBodyHeader()` Gets the relation body in XML-style text
`java.lang.String`	`printBodyXMLWithoutBodyHeader()` Gets the relation body in XML-style text EXCLUDING the <Body>container
`java.lang.String`	`printValueEscapedWithoutTypeNames()` Gets this relation value in SIRAPRISE syntactical format (i.e.
`java.lang.String`	`printValueEscapedWithTypeNames()` Gets this relation value in SIRAPRISE syntactical format (i.e.
`java.lang.String`	`printValueWithoutTypeNames()` Gets this relation value in 'plain text' format (i.e.
`java.lang.String`	`printValueWithTypeNames()` Gets this relation value in 'plain text' format (i.e.
`java.lang.String`	`printValueXML()` Gets this relation value in 'XML text' format.
`int`	`size()` Gets The number of tuples that appear in the relation.
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable
forEach, spliterator

- Constructor Detail
  - TupleContainer
```
public TupleContainer(Heading heading,
                      TupleCollectionBuffer tupleCollectionBuffer)
```
    Creates the AbstractTupleContainer
    
    Parameters:
    
    heading - The heading for tuple container.
    
    tupleCollectionBuffer - The buffer holding the collection of tuples that constitutes the relation or bag value
- Method Detail
  - getHeading
```
public final Heading getHeading()
```
    Gets The heading for tuple container.
    
    Returns:
    
    The heading for tuple container.
  - getTupleCollectionBuffer
```
public final TupleCollectionBuffer getTupleCollectionBuffer()
```
    Gets tupleCollectionBuffer
    
    Returns:
    
    tupleCollectionBuffer.
  - iterator
```
public final java.util.Iterator<Tuple> iterator()
```
    Gets an iterator over the tuples in the container
    
    Specified by:
    
    iterator in interface java.lang.Iterable<Tuple>
    
    Returns:
    
    an iterator over the tuples in the container
  - printBodyEscapedWithBodyHeaderWithTypeNames
```
public final java.lang.String printBodyEscapedWithBodyHeaderWithTypeNames()
```
    Gets the relation body in text
    
    Returns:
    
    The relation body in text
  - printBodyEscapedWithoutBodyHeaderWithoutTypeNames
```
public final java.lang.String printBodyEscapedWithoutBodyHeaderWithoutTypeNames()
```
    Gets the relation body in text EXCLUDING the BODY( ) container
    
    Returns:
    
    The relation body in text EXCLUDING the BODY( ) container
  - printBodyEscapedWithoutBodyHeaderWithTypeNames
```
public final java.lang.String printBodyEscapedWithoutBodyHeaderWithTypeNames()
```
    Gets the relation body in text EXCLUDING the BODY( ) container
    
    Returns:
    
    The relation body in text EXCLUDING the BODY( ) container
  - printBodyWithoutBodyHeaderWithoutTypeNames
```
public final java.lang.String printBodyWithoutBodyHeaderWithoutTypeNames()
```
    Gets the relation body in text EXCLUDING the BODY( ) container
    
    Returns:
    
    The relation body in text EXCLUDING the BODY( ) container
  - printBodyWithoutBodyHeaderWithTypeNames
```
public final java.lang.String printBodyWithoutBodyHeaderWithTypeNames()
```
    Gets the relation body in text EXCLUDING the BODY( ) container
    
    Returns:
    
    The relation body in text EXCLUDING the BODY( ) container
  - printBodyXMLWithBodyHeader
```
public final java.lang.String printBodyXMLWithBodyHeader()
```
    Gets the relation body in XML-style text
    
    Returns:
    
    the relation body in XML-style text
  - printBodyXMLWithoutBodyHeader
```
public final java.lang.String printBodyXMLWithoutBodyHeader()
```
    Gets the relation body in XML-style text EXCLUDING the <Body>container
    
    Returns:
    
    the relation body in XML-style text EXCLUDING the <Body>container
  - printValueEscapedWithoutTypeNames
```
public final java.lang.String printValueEscapedWithoutTypeNames()
```
    Gets this relation value in SIRAPRISE syntactical format (i.e. including the SIRA_PRISE escape token preceding any appearance of the tokens '(', ')' and '\' in scalar attribute values in the relation.
    
    Returns:
    
    this relation value in SIRAPRISE syntactical format
  - printValueEscapedWithTypeNames
```
public final java.lang.String printValueEscapedWithTypeNames()
```
    Gets this relation value in SIRAPRISE syntactical format (i.e. including the SIRA_PRISE escape token preceding any appearance of the tokens '(', ')' and '\' in scalar attribute values in the relation.
    
    Returns:
    
    this relation value in SIRAPRISE syntactical format
  - printValueWithoutTypeNames
```
public final java.lang.String printValueWithoutTypeNames()
```
    Gets this relation value in 'plain text' format (i.e. if a scalar attribute value includes any of the tokens '(', ')' or '\', these will appear 'as is' in the string value and will not be replaced by the appropriate SIRA_PRISE escape sequence.
    
    Returns:
    
    this relation value in 'plain text' format.
  - printValueWithTypeNames
```
public final java.lang.String printValueWithTypeNames()
```
    Gets this relation value in 'plain text' format (i.e. if a scalar attribute value includes any of the tokens '(', ')' or '\', these will appear 'as is' in the string value and will not be replaced by the appropriate SIRA_PRISE escape sequence.
    
    Returns:
    
    this relation value in 'plain text' format.
  - printValueXML
```
public final java.lang.String printValueXML()
```
    Gets this relation value in 'XML text' format.
    
    Returns:
    
    this relation value in 'plain text' format.
  - size
```
public final int size()
```
    Gets The number of tuples that appear in the relation.
    
    Returns:
    
    The number of tuples that appear in the relation.
  - toString
```
public final java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class TupleContainer

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Iterable

Constructor Detail

TupleContainer

Method Detail

getHeading

getTupleCollectionBuffer

iterator

printBodyEscapedWithBodyHeaderWithTypeNames

printBodyEscapedWithoutBodyHeaderWithoutTypeNames

printBodyEscapedWithoutBodyHeaderWithTypeNames

printBodyWithoutBodyHeaderWithoutTypeNames

printBodyWithoutBodyHeaderWithTypeNames

printBodyXMLWithBodyHeader

printBodyXMLWithoutBodyHeader

printValueEscapedWithoutTypeNames

printValueEscapedWithTypeNames

printValueWithoutTypeNames

printValueWithTypeNames

printValueXML

size

toString