org.apache.stanbol.entityhub.servicesapi.query

Interface EntityQuery

All Superinterfaces:

Cloneable, Query

public interface EntityQuery
extends Query

A simple Search service that is intended for Entity lookup based on

• Tags/Keywords by parsing the exact name
• Prefix to provide suggestions for users that type some characters into a search field.

Results of such queries will be Representation with the following fields

• id (required)
• name (required) by using field Enum.name()
• rank (required) by using field
• description (optional)
• image (optional)
• type (optional)

Specific implementations may add additional fields. All fields MUST BE part of the list returned by QueryResultList.getSelectedFields(). TODO: define the URIs of the results

Author:

Rupert Westenthaler

Method Summary

Methods

Modifier and Type	Method and Description
String	getEntityType() The type of the entity TODO: currently symbols define only a required name and description, but often it is also the type that is used to filter individuals.
String	getName() Getter for the name/name fragment of the entity to search
boolean	isPrefix() If Prefix is enabled, the parsed name is interpreted as prefix.

Methods inherited from interface org.apache.stanbol.entityhub.servicesapi.query.Query

clone, getLimit, getOffset, getQueryType, setLimit, setOffset

Method Detail

getName

String getName()

Getter for the name/name fragment of the entity to search

Returns:

the name

isPrefix

boolean isPrefix()

If Prefix is enabled, the parsed name is interpreted as prefix. The regex representation would be "^"+getName()+".*$"

Returns:

getEntityType

String getEntityType()

The type of the entity TODO: currently symbols define only a required name and description, but often it is also the type that is used to filter individuals. Therefore it could make sense to also add the type to the properties of symbols

Returns:

the type of the entities (full name, no wildcard support)