org.mozilla.mentat

Class TupleResult

java.lang.Object

org.mozilla.mentat.TupleResult

All Implemented Interfaces:

AutoCloseable

Direct Known Subclasses:

CollResult

public class TupleResult
extends Object

Wraps a `Tuple` result from a Mentat query. A `Tuple` result is a single row TypedValues. Values for individual fields can be fetched as TypedValue or converted into a requested type.

Field values can be fetched as one of the following types:

• TypedValue
• long
• Entid (as long)
• Keyword (as String)
• boolean
• double
• Date
• String
• UUID

To iterate over the result set use standard iteration flows.

Constructor Summary

Constructors

Constructor and Description
TupleResult(JNA.TypedValueList pointer)

Method Summary

Modifier and Type	Method and Description
Boolean	asBool(Integer index) Return the Boolean at the specified index.
Date	asDate(Integer index) Return the Date at the specified index.
Double	asDouble(Integer index) Return the Double at the specified index.
Long	asEntid(Integer index) Return the Entid at the specified index.
String	asKeyword(Integer index) Return the keyword String at the specified index.
Long	asLong(Integer index) Return the Long at the specified index.
String	asString(Integer index) Return the String at the specified index.
UUID	asUUID(Integer index) Return the UUID at the specified index.
void	close()
protected void	destroyPointer(JNA.TypedValueList p)
protected void	finalize()
TypedValue	get(Integer index) Return the TypedValue at the specified index.

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TupleResult

public TupleResult(JNA.TypedValueList pointer)

Method Detail

get

public TypedValue get(Integer index)

Return the TypedValue at the specified index. If the index is greater than the number of values then this function will crash.

Parameters:

index - The index of the value to fetch.

Returns:

The TypedValue at that index.

asLong

public Long asLong(Integer index)

Return the Long at the specified index. If the index is greater than the number of values then this function will crash. If the value type if the TypedValue at this index is not `Long` then this function will crash.

Parameters:

index - The index of the value to fetch.

Returns:

The Long at that index.

asEntid

public Long asEntid(Integer index)

Return the Entid at the specified index. If the index is greater than the number of values then this function will crash. If the value type if the TypedValue at this index is not `Ref` then this function will crash.

Parameters:

index - The index of the value to fetch.

Returns:

The Entid at that index.

asKeyword

public String asKeyword(Integer index)

Return the keyword String at the specified index. If the index is greater than the number of values then this function will crash. If the value type if the TypedValue at this index is not `Keyword` then this function will crash.

Parameters:

index - The index of the value to fetch.

Returns:

The keyword at that index.

asBool

public Boolean asBool(Integer index)

Return the Boolean at the specified index. If the index is greater than the number of values then this function will crash. If the value type if the TypedValue at this index is not `Boolean` then this function will crash.

Parameters:

index - The index of the value to fetch.

Returns:

The Boolean at that index.

asDouble

public Double asDouble(Integer index)

Return the Double at the specified index. If the index is greater than the number of values then this function will crash. If the value type if the TypedValue at this index is not `Double` then this function will crash.

Parameters:

index - The index of the value to fetch.

Returns:

The Double at that index.

asDate

public Date asDate(Integer index)

Return the Date at the specified index. If the index is greater than the number of values then this function will crash. If the value type if the TypedValue at this index is not `Instant` then this function will crash.

Parameters:

index - The index of the value to fetch.

Returns:

The Date at that index.

asString

public String asString(Integer index)

Return the String at the specified index. If the index is greater than the number of values then this function will crash. If the value type if the TypedValue at this index is not `String` then this function will crash.

Parameters:

index - The index of the value to fetch.

Returns:

The String at that index.

asUUID

public UUID asUUID(Integer index)

Return the UUID at the specified index. If the index is greater than the number of values then this function will crash. If the value type if the TypedValue at this index is not `Uuid` then this function will crash.

Parameters:

index - The index of the value to fetch.

Returns:

The UUID at that index.

destroyPointer

protected void destroyPointer(JNA.TypedValueList p)

close

public void close()

Specified by:

close in interface AutoCloseable

finalize

protected void finalize()

Overrides:

finalize in class Object