ORMTemporalAttributeStorage (JTemporal)

Overview

Package

Class

Tree

Deprecated

Index

Help

JTemporal Home
Tutorial

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

net.sf.jtemporal.spi
Class ORMTemporalAttributeStorage<V>

java.lang.Object
  net.sf.jtemporal.spi.ORMTemporalAttributeStorage<V>

All Implemented Interfaces:: java.io.Serializable, TemporalAttributeStorage

public class ORMTemporalAttributeStorage<V>
extends java.lang.Object
implements TemporalAttributeStorage, java.io.Serializable
extends java.lang.Object
implements TemporalAttributeStorage, java.io.Serializable

An implementation of TemporalAttributeStorage#, based on a TreeMap, mapped by an ORM tool.

Version:: $Id: ORMTemporalAttributeStorage.java,v 1.10 2007/09/23 20:07:16 tabeck Exp $
See Also:: Serialized Form

Constructor Summary
`ORMTemporalAttributeStorage(java.util.SortedMap<Period,TimedObject<V>> sortedMap, TimedObjectFactory<V> toFactory)` You specify an instance of SortedMap to be used internally by the storage.

Method Summary
`void`	`beginAtomicOperation()` Tells the storage that the JTemporal client is calling a method that can result in multiples updates in the storage.
`void`	`clear()` Removes all the stored mappings.
`boolean`	`containsValue(java.lang.Object value)` Returns `true` if this map maps one or more Periods to the specified value.
`boolean`	`containsValue(java.lang.Object value, Period range)` Returns `true` if this map maps one or more Periods to the specified value, during the specified period.
`void`	`endAtomicOperation()` Tells the storage that an atomic operation has finished.
`CloseableIterator`	`entryIterator()` Iterates over all the entries of the storage.
`CloseableIterator`	`entryIterator(Period range)` Iterates over all the entries of the storage that intersects the period P.
`Period`	`firstPeriod()` Returns the first (lowest) period currently in this storage.
`Period`	`firstPeriod(Period range)` Returns the first (lowest) period currently in this storage, that intersects the given period.
`TimedObject`	`getEntry(Instant instant)` Returns the entry valid at the given instant, if any is found.
`TimedObject`	`getEntryEndingAt(Instant instant)` Returns the entry finishing exactly at the given instant, if any is found.
`TimedObject`	`getEntryStartingAt(Instant instant)` Returns the entry starting exactly at the given instant, if any is found.
`Period`	`getPeriod(Instant instant)` Returns the period that encloses the given instant, if any is found.
`V`	`getValue(Instant instant)` Returns the value to which this map maps the specified Instant.
`boolean`	`isEmpty()` Returns `true` if this storage does not contain objects.
`boolean`	`isEmpty(Period range)` Returns `true` if this storage does not contain objects intersecting the given period.
`Period`	`lastPeriod()` Returns the last (highest) period currently in this storage.
`Period`	`lastPeriod(Period range)` Returns the last (highest) period currently in this storage, that intersects the given period.
`CloseableIterator`	`periodIterator()` Iterates over all the periods of the storage.
`CloseableIterator`	`periodIterator(Period range)` Iterates over all the periods of the storage that intersects the period P.
`void`	`put(Period p, java.lang.Object value)` Stores a mapping (entry, tuple, row) composed by period and value.
`void`	`removeEntry(Period p)` Removes an entry composed by period and value previously stored.
`int`	`removeRange(Period range)` Removes all the entries whose period indersects the given period.
`int`	`size()` Returns the number of Period-value mappings in this map.
`int`	`size(Period range)` Returns the number of Period-value mappings in this map, for the given priod.
`java.lang.String`	`toString()`

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

Constructor Detail

ORMTemporalAttributeStorage

public ORMTemporalAttributeStorage(java.util.SortedMap<Period,TimedObject<V>> sortedMap,
                                   TimedObjectFactory<V> toFactory)

You specify an instance of SortedMap to be used internally by the storage. This can be useful in the case your Object-Relational mapping tool can provide a persistent implementation of the sorted Map.
The SortedMap instance must comply with the following requirements:
- use StartComparator.COMPARATOR or a new instance of net.sf.jtemporal.spi.TreeTemporalAttributeStorage$StartComparator
- have the key containing Periods and the value containing the value to be returned by TemporalAttribute.get(Instant).

Parameters:: sortedMap - a map mapped by an ORM tools, whose key is composed of Period and the value of TimedObject, using as a comparator StartComparator.COMPARATOR. Note that the getValue(Instant) will return just the value held in the TimedObject and not the timedObject itself. This, because the TimedObject is the closed representation of a row in your database, that is mapped by your ORM tool.
Note that the TimedObjects and their components must immutable. They will be created and deleted from the database, but never updated.; toFactory - a callback for creating and destroying instances of TimedObject
Throws:: java.lang.IllegalArgumentException - if the map does not use StartComparator.COMPARATOR. or if the map is null

Method Detail