org.nuxeo.ecm.platform.semanticentities.service

Class ParameterizedHTTPEntitySource

java.lang.Object

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

All Implemented Interfaces:

RemoteEntitySource

Direct Known Subclasses:

DBpediaEntitySource, StanbolEntityHubSource

public abstract class ParameterizedHTTPEntitySource
extends Object
implements RemoteEntitySource

Abstract base class to be used by all contributions to the RemoteEntityServiceImpl service. Factorize common mapping logic and offer public methods to help the service set parameters from the descriptor.

Field Summary

Fields

Modifier and Type	Field and Description
static String	OWL_THING
static String	RDF_TYPE

Constructor Summary

Constructors

Constructor and Description
ParameterizedHTTPEntitySource()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canDereference(URI remoteEntity)
boolean	canSuggestRemoteEntity()
void	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.
void	setDescriptor(RemoteEntitySourceDescriptor descriptor)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.nuxeo.ecm.platform.semanticentities.RemoteEntitySource

dereferenceInto, getAdmissibleTypes, suggestRemoteEntity

Field Detail

OWL_THING

public static final String OWL_THING

See Also:

Constant Field Values

RDF_TYPE

public static final String RDF_TYPE

See Also:

Constant Field Values

Constructor Detail

ParameterizedHTTPEntitySource

public ParameterizedHTTPEntitySource()

Method Detail

setDescriptor

public void setDescriptor(RemoteEntitySourceDescriptor descriptor)

canDereference

public boolean canDereference(URI remoteEntity)

Specified by:

canDereference in interface RemoteEntitySource

Returns:

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

canSuggestRemoteEntity

public boolean canSuggestRemoteEntity()

Specified by:

canSuggestRemoteEntity in interface RemoteEntitySource

Returns:

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

dereferenceIntoFromModel

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

Description copied from interface: RemoteEntitySource

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.

Specified by:

dereferenceIntoFromModel in interface RemoteEntitySource

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.

Throws:

DereferencingException