Interface EntityMaps
-
- All Known Implementing Classes:
SimpleEntityMaps
public interface EntityMaps extends Iterable<EntityMap>
AnEntityMaps
object contains a number ofEntityMap
objects and can be used to represent the changes in an EntityMap over time or to track the entities of a graph over some other metric.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description default void
add(EntityMap entityMap)
Add a newEntityMap
.List<EntityMap>
asList()
Get a representation of the current EntityMaps object as aList
.default boolean
empty()
Returntrue
if this EntityMaps object is empty, otherwisefalse
.default EntityMap
get(int n)
Retrieve the nthEntityMap
.default Iterator<EntityMap>
iterator()
default String
prettyPrint()
Print theEntityMap
object in an easily readable format.default int
size()
Return the number ofEntityMap
present in the entityMaps object.-
Methods inherited from interface java.lang.Iterable
forEach, spliterator
-
-
-
-
Method Detail
-
add
default void add(EntityMap entityMap)
Add a newEntityMap
.- Parameters:
entityMap
- the entityMap to add
-
get
default EntityMap get(int n)
Retrieve the nthEntityMap
.- Parameters:
n
- the index of the adjacency map to retrieve- Returns:
- the nth entityMap
-
size
default int size()
Return the number ofEntityMap
present in the entityMaps object.Depending on the context, this could refer to the number of hops present, or the number of timesteps etc.
- Returns:
- the size of the entityMaps object
-
empty
default boolean empty()
Returntrue
if this EntityMaps object is empty, otherwisefalse
.- Returns:
- the empty state of this object
-
prettyPrint
default String prettyPrint()
Print theEntityMap
object in an easily readable format.- Returns:
- a prettily printed
String
representation of the entityMap object.
-
asList
List<EntityMap> asList()
Get a representation of the current EntityMaps object as aList
.- Returns:
- a
List
representation of the current entityMaps object
-
-