org.nuxeo.ecm.platform.semanticentities.sources

Class StanbolEntityHubSource

java.lang.Object

org.nuxeo.ecm.platform.semanticentities.service.ParameterizedHTTPEntitySource

org.nuxeo.ecm.platform.semanticentities.sources.StanbolEntityHubSource

All Implemented Interfaces:

RemoteEntitySource

public class StanbolEntityHubSource
extends ParameterizedHTTPEntitySource

Implementation of the RemoteEntitySource interface from the HTTP endpoint of the EntityHub of a Stanbol instance.

Field Summary

Fields

Modifier and Type	Field and Description
static String	RDF_TYPE

Fields inherited from class org.nuxeo.ecm.platform.semanticentities.service.ParameterizedHTTPEntitySource

OWL_THING

Constructor Summary

Constructors

Constructor and Description
StanbolEntityHubSource()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	dereferenceInto(DocumentModel localEntity, URI remoteEntity, boolean override, boolean lazyResourceFetch) Dereference a remote entity into an existing document model.
Set<String>	getAdmissibleTypes(URI remoteEntity) Introspect the referenced entity to suggest which Nuxeo types can be used to dereference this entity.
void	setDescriptor(RemoteEntitySourceDescriptor descriptor)
List<EntitySuggestion>	suggestRemoteEntity(String keywords, String type, int maxSuggestions) Perform query on registered remote entity sources to suggests entity definitions that match the name given as keywords and the requested entity type.

Methods inherited from class org.nuxeo.ecm.platform.semanticentities.service.ParameterizedHTTPEntitySource

canDereference, canSuggestRemoteEntity, dereferenceIntoFromModel

Methods inherited from class java.lang.Object

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

Field Detail

RDF_TYPE

public static final String RDF_TYPE

See Also:

Constant Field Values

Constructor Detail

StanbolEntityHubSource

public StanbolEntityHubSource()

Method Detail

setDescriptor

public void setDescriptor(RemoteEntitySourceDescriptor descriptor)

Overrides:

setDescriptor in class ParameterizedHTTPEntitySource

getAdmissibleTypes

public Set<String> getAdmissibleTypes(URI remoteEntity)
                               throws DereferencingException

Description copied from interface: RemoteEntitySource

Introspect the referenced entity to suggest which Nuxeo types can be used to dereference this entity. The first element of the list should be the type the user should expect in front facing label (e.g. the most specific). Hence the set implementation should imply unicity as all set but also preserver ordering (e.g. a LinkedHashSet for instance).

Parameters:

remoteEntity - the URI of the entity to dereference

Returns:

an ordered set of Nuxeo Core type names that can be used to dereference the entity into a local copy

Throws:

DereferencingException

dereferenceInto

public boolean dereferenceInto(DocumentModel localEntity,
                      URI remoteEntity,
                      boolean override,
                      boolean lazyResourceFetch)
                        throws DereferencingException

Description copied from interface: RemoteEntitySource

Dereference a remote entity into an existing document model. Only non empty local fields are updated, unless override is set to true. It is the responsibility of the method caller to save the updated document model back to the repository.

Parameters:

localEntity - local document model to store a copy of the entity attribute

remoteEntity - the URI of the entity to dereference

override - replace non-empty local fields with values from the remote entity

lazyResourceFetch - if true, delay the fetch of the content of referenced resources (e.g. JPEG images) to first access.

Returns:

true if a suitable remote entity description was found in the source, false otherwise.

Throws:

DereferencingException

suggestRemoteEntity

public List<EntitySuggestion> suggestRemoteEntity(String keywords,
                                         String type,
                                         int maxSuggestions)
                                           throws IOException

Description copied from interface: RemoteEntitySource

Perform query on registered remote entity sources to suggests entity definitions that match the name given as keywords and the requested entity type. The caller will then typically ask the user to select one of the suggestions and then dereference of the remote entity into a local copy for easy off-line reuse and indexing in the local repository. The suggestion backend should order the results by a mix of keyword relevance and popularity.

Throws:

IOException