Package org.fiware.mintaka.persistence

Class TimescaleBackedEntityRepository

java.lang.Object

org.fiware.mintaka.persistence.TimescaleBackedEntityRepository

All Implemented Interfaces:

EntityRepository

@Singleton
public class TimescaleBackedEntityRepository
extends Object
implements EntityRepository

Repository implementation for retrieving temporal entity representations from the timescale database

Field Summary

Fields

Modifier and Type	Field	Description
static final int	EXPECTED_RESULT_SIZE
static final DateTimeFormatter	LOCAL_DATE_TIME_FORMATTER

Constructor Summary

Constructors

Constructor	Description
TimescaleBackedEntityRepository(javax.persistence.EntityManager entityManager)

Method Summary

Modifier and Type	Method	Description
LimitableResult<List<Attribute>>	findAttributeByEntityId(String entityId, TimeQuery timeQuery, List<String> attributes, Integer limit, boolean backwards)	Find all attributes of an entity in the define timeframe
List<String>	findAttributesByEntityIds(List<String> entityIds, String timeQueryPart)	Find all attributes for the given entities in that timequery.
Optional<NgsiEntity>	findById(String entityId, TimeQuery timeQuery)	Retrieve the entity from the db.
List<EntityIdTempResults>	findEntityIdsAndTimeframesByQuery(Optional<List<String>> idList, Optional<String> idPattern, List<String> types, TimeQuery timeQuery, Optional<GeoQuery> geoQuery, Optional<QueryTerm> queryTerm, int pageSize, Optional<String> anchor)	Query for timeframe and entityIds where all query elements are fulfilled.
List<SubAttribute>	findSubAttributeInstancesForAttributeAndEntity(String entityId, String attributeInstanceId, int limit, boolean backwards)	Return all sub attribute instances for the given attribute instance
Number	getCount(Optional<List<String>> idList, Optional<String> idPattern, List<String> types, TimeQuery timeQuery, Optional<GeoQuery> geoQuery, Optional<QueryTerm> queryTerm)	Count the number of entityId results for the given query
List<Instant>	getCreatedAtForAttribute(String attributeId, String entityId, boolean isSubAttribute)	Get the list of timestamps that have opMode "create" for the given attribute.
Optional<NgsiEntity>	getEntityIfExists(String entityId)	Return an entity in case there are any instances of the entity in timescale db.
int	getLimit(int entitiesNumber, int attributesNumber, Integer lastN)	Get the limit to be used for the given configuration
PaginationInformation	getPaginationInfo(Optional<List<String>> idList, Optional<String> idPattern, List<String> types, TimeQuery timeQuery, Optional<GeoQuery> geoQuery, Optional<QueryTerm> queryTerm, int pageSize, Optional<String> anchor)	Get the pagination information for the given query.

Methods inherited from class java.lang.Object

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

Field Details

LOCAL_DATE_TIME_FORMATTER

public static final DateTimeFormatter LOCAL_DATE_TIME_FORMATTER

EXPECTED_RESULT_SIZE

public static final int EXPECTED_RESULT_SIZE

See Also:

• Constant Field Values

Constructor Details

TimescaleBackedEntityRepository

public TimescaleBackedEntityRepository(@Named("default")
 javax.persistence.EntityManager entityManager)

Method Details

findById

public Optional<NgsiEntity> findById(String entityId,
 TimeQuery timeQuery)

Description copied from interface: EntityRepository

Retrieve the entity from the db.

Specified by:

findById in interface EntityRepository

Parameters:

entityId - id of the entity to retrieve

Returns:

optional entity

findAttributeByEntityId

public LimitableResult<List<Attribute>> findAttributeByEntityId(String entityId,
 TimeQuery timeQuery,
 List<String> attributes,
 Integer limit,
 boolean backwards)

Description copied from interface: EntityRepository

Find all attributes of an entity in the define timeframe

Specified by:

findAttributeByEntityId in interface EntityRepository

Parameters:

entityId - id to get attributes for

timeQuery - time related query

attributes - the attributes to be included, if null or empty return all

Returns:

list of attribute instances

getLimit

public int getLimit(int entitiesNumber,
 int attributesNumber,
 Integer lastN)

Description copied from interface: EntityRepository

Get the limit to be used for the given configuration

Specified by:

getLimit in interface EntityRepository

Parameters:

entitiesNumber - - entities to be returned

attributesNumber - - attributes to be returned per entity

lastN - - number of last values to be returned

Returns:

the limit to apply

findEntityIdsAndTimeframesByQuery

public List<EntityIdTempResults> findEntityIdsAndTimeframesByQuery(Optional<List<String>> idList,
 Optional<String> idPattern,
 List<String> types,
 TimeQuery timeQuery,
 Optional<GeoQuery> geoQuery,
 Optional<QueryTerm> queryTerm,
 int pageSize,
 Optional<String> anchor)

Description copied from interface: EntityRepository

Query for timeframe and entityIds where all query elements are fulfilled.

Specified by:

findEntityIdsAndTimeframesByQuery in interface EntityRepository

idPattern - pattern to check ids

types - types to include

timeQuery - timeframe definition

geoQuery - geo related query

queryTerm - ngsi query

Returns:

the list of entityIds and there timeframes

getCount

public Number getCount(Optional<List<String>> idList,
 Optional<String> idPattern,
 List<String> types,
 TimeQuery timeQuery,
 Optional<GeoQuery> geoQuery,
 Optional<QueryTerm> queryTerm)

Description copied from interface: EntityRepository

Count the number of entityId results for the given query

Specified by:

getCount in interface EntityRepository

idPattern - pattern to check ids

types - types to include

timeQuery - timeframe definition

geoQuery - geo related query

queryTerm - ngsi query

Returns:

number of matching entities

getPaginationInfo

public PaginationInformation getPaginationInfo(Optional<List<String>> idList,
 Optional<String> idPattern,
 List<String> types,
 TimeQuery timeQuery,
 Optional<GeoQuery> geoQuery,
 Optional<QueryTerm> queryTerm,
 int pageSize,
 Optional<String> anchor)

Description copied from interface: EntityRepository

Get the pagination information for the given query.

Specified by:

getPaginationInfo in interface EntityRepository

findSubAttributeInstancesForAttributeAndEntity

public List<SubAttribute> findSubAttributeInstancesForAttributeAndEntity(String entityId,
 String attributeInstanceId,
 int limit,
 boolean backwards)

Description copied from interface: EntityRepository

Return all sub attribute instances for the given attribute instance

Specified by:

findSubAttributeInstancesForAttributeAndEntity in interface EntityRepository

Parameters:

entityId - entity the attributes and subattributes are connected to

attributeInstanceId - id of the concrete attribute

limit - number of instances to be retrieved

backwards - should the instances be retrieved in reversed order.

Returns:

list of subattribute instances

findAttributesByEntityIds

public List<String> findAttributesByEntityIds(List<String> entityIds,
 String timeQueryPart)

Description copied from interface: EntityRepository

Find all attributes for the given entities in that timequery.

Specified by:

findAttributesByEntityIds in interface EntityRepository

Parameters:

entityIds - entities to be associated with the attributes

timeQueryPart - timeframe to search for

Returns:

list of attributes

getCreatedAtForAttribute

public List<Instant> getCreatedAtForAttribute(String attributeId,
 String entityId,
 boolean isSubAttribute)

Description copied from interface: EntityRepository

Get the list of timestamps that have opMode "create" for the given attribute.

Specified by:

getCreatedAtForAttribute in interface EntityRepository

Parameters:

attributeId - id of the attribute to find the timestamps for

entityId - id of the entity that are connected with the attribute

isSubAttribute - is the requestend attribute an attribute or a subattribute

Returns:

the list of timestamps

getEntityIfExists

public Optional<NgsiEntity> getEntityIfExists(String entityId)

Description copied from interface: EntityRepository

Return an entity in case there are any instances of the entity in timescale db.

Specified by:

getEntityIfExists in interface EntityRepository

Parameters:

entityId - id of the entity to check

Returns:

NgsiEntity if one exists