com.bigdata.sparse
Interface ITPS

All Known Implementing Classes:

TPS

public interface ITPS

A Timestamp Property Set is a property set with timestamp property values representing data for a specific Schema.

Version:

$Id: ITPS.java 2265 2009-10-26 12:51:06Z thompsonbry $

Author:

Bryan Thompson

Method Summary

Map<String,Object>	asMap() Return a copy of the tuples showing only the most recent value for each property.
Map<String,Object>	asMap(long timestamp) Return a copy of the tuples showing only the most recent value for each property whose timestamp is not greater than the given timestamp.
Map<String,Object>	asMap(long timestamp, INameFilter filter) Return a copy of the tuples showing only the most recent value for each property whose timestamp is not greater than the given timestamp.
ITPV	get(String name) Return the most recent value for the named property.
ITPV	get(String name, long timestamp) Return the most recent value for the named property whose timestamp is not greater than the specified timestamp.
Object	getPrimaryKey() The value of the primary key.
Schema	getSchema() The Schema name.
long	getWriteTimestamp() The timestamp assigned by an atomic write operation (for atomic readback only).
Iterator<ITPV>	iterator() Visits all tuples in order by ascending timestamp.
int	size() The #of tuples - each tuple is an ITPV.

Method Detail

getSchema

Schema getSchema()

The Schema name.

getPrimaryKey

Object getPrimaryKey()

The value of the primary key.

Returns:

The value of the primary key -or- null if there is no property value bound for the property named by Schema.getName().

getWriteTimestamp

long getWriteTimestamp()

The timestamp assigned by an atomic write operation (for atomic readback only).

Returns:

The timestamp.

Throws:

IllegalStateException - if no timestamp has been assigned.

size

int size()

The #of tuples - each tuple is an ITPV.

get

ITPV get(String name,
         long timestamp)

Return the most recent value for the named property whose timestamp is not greater than the specified timestamp.

Parameters:

name - The property name.

timestamp - The timestamp.

Returns:

An object representing value of the property as of the indicated timestamp and never null.

get

ITPV get(String name)

Return the most recent value for the named property.

Parameters:

name - The propery name.

Returns:

An object representing value of the property as of the indicated timestamp and never null. If no value was found for the named property, then ITPV.getValue() will return null and ITPV.getTimestamp() will return 0L.

iterator

Iterator<ITPV> iterator()

Visits all tuples in order by ascending timestamp.

asMap

Map<String,Object> asMap()

Return a copy of the tuples showing only the most recent value for each property.

asMap

Map<String,Object> asMap(long timestamp)

Return a copy of the tuples showing only the most recent value for each property whose timestamp is not greater than the given timestamp.

Parameters:

timestamp - The timestamp (use Long.MAX_VALUE to read the most recent value for each property).

Returns:

A map containing a copy of the selected property values. A deleted property will not be contained in the map.

asMap

Map<String,Object> asMap(long timestamp,
                         INameFilter filter)

Return a copy of the tuples showing only the most recent value for each property whose timestamp is not greater than the given timestamp.

Parameters:

timestamp - The timestamp (use Long.MAX_VALUE to read the most recent value for each property).

filter - An optional filter that may be used to select only specific property names.

Returns:

A map containing a copy of the selected property values. A deleted property will not be contained in the map.