|
Neo4j Enterprise | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface TimelineIndex<T extends PropertyContainer>
A utility for ordering nodes or relationships in a timeline. Entities are added
to the timeline and then queried given a time period, w/ or w/o lower/upper
bounds, for example "Give me all entities before this given timestamp" or
"Give me all nodes between these two timestamps".
Please note that the timestamps don't need to represent actual points in
time, any long
that identifies the indexed Node
or
Relationship
and defines its global order is fine.
Method Summary | |
---|---|
void |
add(T entity,
long timestamp)
Adds an entity to this timeline with the given timestamp . |
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. |
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. |
Method Detail |
---|
T getLast()
null
if the timeline is empty.T getFirst()
null
if the timeline is empty.void remove(T entity, long timestamp)
entity
- the entity to remove from this timeline.timestamp
- the timestamp this entity was added with.void add(T entity, long timestamp)
timestamp
.
entity
- the entity to add to this timeline.timestamp
- the timestamp to use.IndexHits<T> getBetween(Long startTimestampOrNull, Long endTimestampOrNull, boolean reversed)
reversed
is
true
the order of the result is reversed.
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 timestampreversed
- reverses the result order if true
.
value will be returned (exclude). Will be ignored if null
.
IndexHits<T> getBetween(Long startTimestampOrNull, Long endTimestampOrNull)
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
.
|
Neo4j Enterprise | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |