org.apache.jena.query.text.es

Class TextIndexES

java.lang.Object

org.apache.jena.query.text.es.TextIndexES

All Implemented Interfaces:

org.apache.jena.atlas.lib.Closeable, TextIndex

public class TextIndexES
extends Object
implements TextIndex

Elastic Search Implementation of TextIndex

Constructor Summary

Constructors

Constructor and Description
TextIndexES(TextIndexConfig config, org.elasticsearch.client.Client client, String indexName) Constructor used mainly for performing Integration tests
TextIndexES(TextIndexConfig config, ESSettings esSettings) Construct an instance of TextIndexES based on provided TextIndexConfig and ESSettings The constructor is responsible for initializing a TransportClient based on the provided configs and create index based on the provided ESSettings

Method Summary

Modifier and Type	Method and Description
void	addEntity(Entity entity) Add an Entity to the ElasticSearch Index.
void	close() We don't have resources that need to be closed explicitly
void	commit() Commit happens in the individual get/add/delete operations
void	deleteEntity(Entity entity) Delete the value of the entity from the existing document, if any.
Map<String,Node>	get(String uri) Get an Entity given the subject Id
EntityDefinition	getDocDef()
void	prepareCommit() We do not have any specific logic to perform before committing
List<TextHit>	query(List<Resource> props, String qs, String graphURI, String lang, int limit, String highlight)
List<TextHit>	query(Node subj, List<Resource> props, String qs, String graphURI, String lang, int limit, String highlight)
List<TextHit>	query(Node property, String qs, String graphURI, String lang)
List<TextHit>	query(Node property, String qs, String graphURI, String lang, int limit) Query the ElasticSearch for the given Node, with the given query String and limit.
List<TextHit>	query(Node property, String qs, String graphURI, String lang, int limit, String highlight)
List<TextHit>	query(String uri, List<Resource> props, String qs, String graphURI, String lang, int limit, String highlight)
void	rollback() We do not do rollback
void	updateEntity(Entity entity) Update an Entity.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.jena.query.text.TextIndex

query

Constructor Detail

TextIndexES

public TextIndexES(TextIndexConfig config,
                   ESSettings esSettings)

Construct an instance of TextIndexES based on provided TextIndexConfig and ESSettings The constructor is responsible for initializing a TransportClient based on the provided configs and create index based on the provided ESSettings

Parameters:

config - an instance of TextIndexConfig

esSettings - an instance of ESSettings

TextIndexES

public TextIndexES(TextIndexConfig config,
                   org.elasticsearch.client.Client client,
                   String indexName)

Constructor used mainly for performing Integration tests

Parameters:

config - an instance of TextIndexConfig

client - an instance of TransportClient. The client should already have been initialized with an index

Method Detail

prepareCommit

public void prepareCommit()

We do not have any specific logic to perform before committing

Specified by:

prepareCommit in interface TextIndex

commit

public void commit()

Commit happens in the individual get/add/delete operations

Specified by:

commit in interface TextIndex

rollback

public void rollback()

We do not do rollback

Specified by:

rollback in interface TextIndex

close

public void close()

We don't have resources that need to be closed explicitly

Specified by:

close in interface org.apache.jena.atlas.lib.Closeable

updateEntity

public void updateEntity(Entity entity)

Update an Entity. Since we are doing Upserts in add entity anyway, we simply call addEntity(Entity) method that takes care of updating the Entity as well.

Specified by:

updateEntity in interface TextIndex

Parameters:

entity - the entity to update.

addEntity

public void addEntity(Entity entity)

Add an Entity to the ElasticSearch Index. The entity will be added as a new document in ES, if it does not already exists. If the Entity exists, then the entity will simply be updated. The entity will never be replaced.

Specified by:

addEntity in interface TextIndex

Parameters:

entity - the entity to add

deleteEntity

public void deleteEntity(Entity entity)

Delete the value of the entity from the existing document, if any. The document itself will never get deleted. Only the value will get deleted.

Specified by:

deleteEntity in interface TextIndex

Parameters:

entity - entity whose value needs to be deleted

get

public Map<String,Node> get(String uri)

Get an Entity given the subject Id

Specified by:

get in interface TextIndex

Parameters:

uri - the subject Id of the entity

Returns:

a map of field name and field values;

query

public List<TextHit> query(Node property,
                           String qs,
                           String graphURI,
                           String lang)

Specified by:

query in interface TextIndex

query

public List<TextHit> query(Node property,
                           String qs,
                           String graphURI,
                           String lang,
                           int limit,
                           String highlight)

Specified by:

query in interface TextIndex

query

public List<TextHit> query(Node property,
                           String qs,
                           String graphURI,
                           String lang,
                           int limit)

Query the ElasticSearch for the given Node, with the given query String and limit.

Specified by:

query in interface TextIndex

Parameters:

property - the node property to make a search for

qs - the query string

limit - limit on the number of records to return

Returns:

List of TextHits containing the documents that have been found

query

public List<TextHit> query(List<Resource> props,
                           String qs,
                           String graphURI,
                           String lang,
                           int limit,
                           String highlight)

Specified by:

query in interface TextIndex

query

public List<TextHit> query(Node subj,
                           List<Resource> props,
                           String qs,
                           String graphURI,
                           String lang,
                           int limit,
                           String highlight)

Specified by:

query in interface TextIndex

query

public List<TextHit> query(String uri,
                           List<Resource> props,
                           String qs,
                           String graphURI,
                           String lang,
                           int limit,
                           String highlight)

Specified by:

query in interface TextIndex

getDocDef

public EntityDefinition getDocDef()

Specified by:

getDocDef in interface TextIndex