eu.fbk.knowledgestore.elastic

Class DataTransactionElastic

java.lang.Object

eu.fbk.knowledgestore.elastic.DataTransactionElastic

All Implemented Interfaces:

DataTransaction

public final class DataTransactionElastic
extends Object
implements DataTransaction

implements DataTransaction interface using ElasticSearch API. does not implement transaction.

Constructor Summary

Constructors

Constructor and Description
DataTransactionElastic(ElasticConfigurations configs, org.elasticsearch.client.Client client, MappingHandler mapper, URIHandler uriHandler)

Method Summary

Modifier and Type	Method and Description
long	count(org.openrdf.model.URI type, XPath condition) the number of documents matching the conditions
void	delete(org.openrdf.model.URI type, org.openrdf.model.URI id) removes a document from the database given it's id
void	deleteAll()
void	deleteAllIndexContent()
void	end(boolean commit) end the "transaction".
Stream<Record>	lookup(org.openrdf.model.URI type, Set<? extends org.openrdf.model.URI> ids, Set<? extends org.openrdf.model.URI> properties) search for the specified ids in the database
Stream<Record>	match(Map<org.openrdf.model.URI,XPath> conditions, Map<org.openrdf.model.URI,Set<org.openrdf.model.URI>> ids, Map<org.openrdf.model.URI,Set<org.openrdf.model.URI>> properties) Evaluates a match request with the parameters supplied.
void	optimizeIndex(int segNumber) merges the segment of the index for reach the specified segment number
Stream<Record>	retrieve(org.openrdf.model.URI type, XPath condition, Set<? extends org.openrdf.model.URI> properties) returns all the documents in the database that match the conditions
void	store(org.openrdf.model.URI type, Record record) stores the specified record in the database.

Methods inherited from class java.lang.Object

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

Constructor Detail

DataTransactionElastic

public DataTransactionElastic(ElasticConfigurations configs,
                              org.elasticsearch.client.Client client,
                              MappingHandler mapper,
                              URIHandler uriHandler)

Parameters:

configs - the configurations

client - ElasticSearch client where to send queries ecc.

mapper - mapping of the types.

Method Detail

lookup

public Stream<Record> lookup(org.openrdf.model.URI type,
                             Set<? extends org.openrdf.model.URI> ids,
                             @Nullable
                             Set<? extends org.openrdf.model.URI> properties)
                      throws IOException,
                             IllegalArgumentException,
                             IllegalStateException

search for the specified ids in the database

Specified by:

lookup in interface DataTransaction

Parameters:

type - mention or resource

ids - identifiers of the documents to search.

properties - properties to keep. (null for all)

Returns:

the documents found.

Throws:

IOException

IllegalArgumentException

IllegalStateException

retrieve

public Stream<Record> retrieve(org.openrdf.model.URI type,
                               @Nullable
                               XPath condition,
                               @Nullable
                               Set<? extends org.openrdf.model.URI> properties)
                        throws IOException,
                               IllegalArgumentException,
                               IllegalStateException

returns all the documents in the database that match the conditions

Specified by:

retrieve in interface DataTransaction

Parameters:

type - mention or resource

condition - condition to match

properties - properties of the documents to keep

Returns:

the documents found.

Throws:

IOException

IllegalArgumentException

IllegalStateException

count

public long count(org.openrdf.model.URI type,
                  @Nullable
                  XPath condition)
           throws IOException,
                  IllegalArgumentException,
                  IllegalStateException

the number of documents matching the conditions

Specified by:

count in interface DataTransaction

Parameters:

type - mention or resource

condition - condition to match

Returns:

the number of documents matching the conditions

Throws:

IOException

IllegalArgumentException

IllegalStateException

match

public Stream<Record> match(Map<org.openrdf.model.URI,XPath> conditions,
                            Map<org.openrdf.model.URI,Set<org.openrdf.model.URI>> ids,
                            Map<org.openrdf.model.URI,Set<org.openrdf.model.URI>> properties)
                     throws IOException,
                            IllegalStateException

Description copied from interface: DataTransaction

Evaluates a match request with the parameters supplied. The operation:

1. Considers all the combinations <resource, mention, entity, axiom> such that
   • mention KS.MENTION_OF resource;
   • mention KS.REFERS_TO entity (optional if no condition or projection on entities);
   • mention KS.EXPRESSES axiom (optional if no condition or projection on axioms).
2. Filters the combinations so that optional conditions / ids selections on resource, mention, entity and axiom components are satisfied.
3. Perform projection with duplicate removal of filtered combinations, keeping only the components occurring in properties.keySet(), returning for each component the subset of properties of properties.get(component_type_URI).

In the maps supplied as parameters, components are identified by their type URI, that is KS.RESOURCE, KS.MENTION, KS.ENTITY and KS.AXIOM.

Specified by:

match in interface DataTransaction

Parameters:

conditions - a non-null map with optional component conditions, indexed by the component type URI; note the map may be possibly empty or contain conditions only for a subset of components

ids - a non-null map with optional ID selections for different components, indexed by the component type URI; note the map may be possibly empty or contain selections only for a subset of components

properties - a non-null, non-empty map with the properties to return for different components, indexed by the component type URI; if the set of property URIs mapped to a component is null or empty, then all the properties of the component should be returned; if a component is not referenced in the map, then it must not be returned

Returns:

a Stream of combination records

Throws:

IOException - in case some IO error occurs

IllegalStateException - if the DataTransaction has been already ended

store

public void store(org.openrdf.model.URI type,
                  Record record)
           throws IOException,
                  IllegalStateException

stores the specified record in the database.

Specified by:

store in interface DataTransaction

Parameters:

type - mention or resource

record - record to store

Throws:

IOException

IllegalStateException

delete

public void delete(org.openrdf.model.URI type,
                   org.openrdf.model.URI id)
            throws IOException,
                   IllegalStateException

removes a document from the database given it's id

Specified by:

delete in interface DataTransaction

Parameters:

type - mention or resource

id - identifier of the document to delete

Throws:

IOException

IllegalStateException

end

public void end(boolean commit)
         throws DataCorruptedException,
                IOException,
                IllegalStateException

end the "transaction".

Specified by:

end in interface DataTransaction

Parameters:

commit -

Throws:

DataCorruptedException

IOException

IllegalStateException

optimizeIndex

public void optimizeIndex(int segNumber)

merges the segment of the index for reach the specified segment number

Parameters:

segNumber - at least 1.

deleteAllIndexContent

public void deleteAllIndexContent()

deleteAll

public void deleteAll()