org.neo4j.index.lucene

Class LuceneTimeline<T extends org.neo4j.graphdb.PropertyContainer>

java.lang.Object

org.neo4j.index.lucene.LuceneTimeline<T>

All Implemented Interfaces:

TimelineIndex<T>

public class LuceneTimeline<T extends org.neo4j.graphdb.PropertyContainer>
extends Object
implements TimelineIndex<T>

Constructor Summary

Constructors

Constructor and Description
LuceneTimeline(org.neo4j.graphdb.GraphDatabaseService db, org.neo4j.graphdb.index.Index<T> index)

Method Summary

Methods

Modifier and Type	Method and Description
void	add(T entity, long timestamp) Adds an entity to this timeline with the given timestamp.
org.neo4j.graphdb.index.IndexHits<T>	getBetween(Long startTimestampOrNull, Long endTimestampOrNull) Query the timeline with optional lower/upper bounds and get back entities within that range, ordered by date with lowest first.
org.neo4j.graphdb.index.IndexHits<T>	getBetween(Long startTimestampOrNull, Long endTimestampOrNull, boolean reversed) Query the timeline with optional lower/upper bounds and get back entities within that range, ordered by date.
T	getFirst()
T	getLast()
void	remove(T entity, long timestamp) Removes an entity from the timeline.

Methods inherited from class java.lang.Object

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

Constructor Detail

LuceneTimeline

public LuceneTimeline(org.neo4j.graphdb.GraphDatabaseService db,
              org.neo4j.graphdb.index.Index<T> index)

Method Detail

getLast

public T getLast()

Specified by:

getLast in interface TimelineIndex<T extends org.neo4j.graphdb.PropertyContainer>

Returns:

the last entity in the timeline, that is the entity with the highest timestamp or null if the timeline is empty.

getFirst

public T getFirst()

Specified by:

getFirst in interface TimelineIndex<T extends org.neo4j.graphdb.PropertyContainer>

Returns:

the first entity in the timeline, that is the entity with the lowest timestamp or null if the timeline is empty.

remove

public void remove(T entity,
          long timestamp)

Description copied from interface: TimelineIndex

Removes an entity from the timeline. The timestamp should be the same as when it was added.

Specified by:

remove in interface TimelineIndex<T extends org.neo4j.graphdb.PropertyContainer>

Parameters:

entity - the entity to remove from this timeline.

timestamp - the timestamp this entity was added with.

add

public void add(T entity,
       long timestamp)

Description copied from interface: TimelineIndex

Adds an entity to this timeline with the given timestamp.

Specified by:

add in interface TimelineIndex<T extends org.neo4j.graphdb.PropertyContainer>

Parameters:

entity - the entity to add to this timeline.

timestamp - the timestamp to use.

getBetween

public org.neo4j.graphdb.index.IndexHits<T> getBetween(Long startTimestampOrNull,
                                              Long endTimestampOrNull)

Description copied from interface: TimelineIndex

Query the timeline with optional lower/upper bounds and get back entities within that range, ordered by date with lowest first.

Specified by:

getBetween in interface TimelineIndex<T extends org.neo4j.graphdb.PropertyContainer>

Parameters:

startTimestampOrNull - the start timestamp, entities with greater timestamp value will be returned (exclusive). Will be ignored if null.

endTimestampOrNull - the end timestamp, entities with lesser timestamp value will be returned (exclude). Will be ignored if null.

Returns:

all entities within the given boundaries in this timeline, ordered by timestamp.

getBetween

public org.neo4j.graphdb.index.IndexHits<T> getBetween(Long startTimestampOrNull,
                                              Long endTimestampOrNull,
                                              boolean reversed)

Description copied from interface: TimelineIndex

Query the timeline with optional lower/upper bounds and get back entities within that range, ordered by date. If reversed is true the order of the result is reversed.

Specified by:

getBetween in interface TimelineIndex<T extends org.neo4j.graphdb.PropertyContainer>

Parameters:

startTimestampOrNull - the start timestamp, entities with greater timestamp value will be returned (exclusive). Will be ignored if null.

endTimestampOrNull - the end timestamp, entities with lesser timestamp

reversed - reverses the result order if true. value will be returned (exclude). Will be ignored if null.

Returns:

all entities within the given boundaries in this timeline, ordered by timestamp.