public interface RemoteEntitySource
Modifier and Type | Method and Description |
---|---|
boolean |
canDereference(URI remoteEntity) |
boolean |
canSuggestRemoteEntity() |
void |
dereferenceInto(DocumentModel localEntity,
URI remoteEntity,
boolean override,
boolean lazyResourceFetch)
Dereference a remote entity into an existing document model.
|
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.
|
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.
|
boolean canSuggestRemoteEntity()
boolean canDereference(URI remoteEntity)
Set<String> getAdmissibleTypes(URI remoteEntity) throws DereferencingException
remoteEntity
- the URI of the entity to dereferenceDereferencingException
void dereferenceInto(DocumentModel localEntity, URI remoteEntity, boolean override, boolean lazyResourceFetch) throws DereferencingException
override
is set to
true
.
It is the responsibility of the method caller to save the updated
document model back to the repository.localEntity
- local document model to store a copy of the entity
attributeremoteEntity
- the URI of the entity to dereferenceoverride
- replace non-empty local fields with values from the
remote entitylazyResourceFetch
- if true, delay the fetch of the content of
referenced resources (e.g. JPEG images) to first access.DereferencingException
void dereferenceIntoFromModel(DocumentModel localEntity, URI remoteEntity, com.hp.hpl.jena.rdf.model.Model rdfModel, boolean override, boolean lazyResourceFetch) throws DereferencingException
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.localEntity
- local document model to store a copy of the entity
attributeremoteEntity
- the URI of the entity to dereferenceoverride
- replace non-empty local fields with values from the
remote entitylazyResourceFetch
- if true, delay the fetch of the content of
referenced resources (e.g. JPEG images) to first access.DereferencingException
List<EntitySuggestion> suggestRemoteEntity(String keywords, String type, int maxSuggestions) throws IOException
IOException
Copyright © 2011 Nuxeo SA. All Rights Reserved.