org.nuxeo.ecm.platform.semanticentities

Interface RemoteEntitySource

All Known Subinterfaces:

RemoteEntityService

All Known Implementing Classes:

DBpediaEntitySource, ParameterizedHTTPEntitySource, RemoteEntityServiceImpl, StanbolEntityHubSource

public interface RemoteEntitySource

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canDereference(URI remoteEntity)
boolean	canSuggestRemoteEntity()
boolean	dereferenceInto(DocumentModel localEntity, URI remoteEntity, boolean override, boolean lazyResourceFetch) Dereference a remote entity into an existing document model.
boolean	dereferenceIntoFromModel(DocumentModel localEntity, URI remoteEntity, com.hp.hpl.jena.rdf.model.Model rdfModel, boolean override, boolean lazyResourceFetch) Dereference a remote entity into an existing document model from a pre-fetched RDF description of the entity.
Set<String>	getAdmissibleTypes(URI remoteEntity) Introspect the referenced entity to suggest which Nuxeo types can be used to dereference this entity.
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.

Method Detail

canSuggestRemoteEntity

boolean canSuggestRemoteEntity()

Returns:

true if the features suggestions by name (a.k.a. entity label)

canDereference

boolean canDereference(URI remoteEntity)

Returns:

true if one of the registered remote sources can handle the provided URI

getAdmissibleTypes

Set<String> getAdmissibleTypes(URI remoteEntity)
                               throws DereferencingException

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

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

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

dereferenceIntoFromModel

boolean dereferenceIntoFromModel(DocumentModel localEntity,
                               URI remoteEntity,
                               com.hp.hpl.jena.rdf.model.Model rdfModel,
                               boolean override,
                               boolean lazyResourceFetch)
                                 throws DereferencingException

Dereference a remote entity into an existing document model from a pre-fetched RDF description of the entity. Only non empty local fields are updated, unless override is set to true. This is typically useful for the SemanticAnalysisService that might receive pre-fetched entity link suggestion and description from the enhancement engines. 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

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

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