org.nuxeo.ecm.platform.semanticentities

Class EntitySuggestion

java.lang.Object

org.nuxeo.ecm.platform.semanticentities.EntitySuggestion

All Implemented Interfaces:

Serializable, Comparable<EntitySuggestion>

public class EntitySuggestion
extends Object
implements Comparable<EntitySuggestion>, Serializable

Data transfer object for the name lookup API of the LocalEntityService: it is represent both local entities (DocumentModel) and remote entities that don't have a match in the local repo represented as in memory DocumentModel or dereferenceable URIs.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
Set<String>	alternativeNames
static String	ALTNAMES_PROPERTY
boolean	automaticallyCreated
DocumentModel	entity
String	label
Set<String>	remoteEntityUris
static String	SAMEAS_LABEL_PROPERTY
static String	SAMEAS_URI_PROPERTY
double	score
String	type

Constructor Summary

Constructors

Constructor and Description
EntitySuggestion(DocumentModel entity)
EntitySuggestion(String label, String remoteEntityUri, String type)

Method Summary

Methods

Modifier and Type	Method and Description
int	compareTo(EntitySuggestion o)
static List<EntitySuggestion>	fromDocument(DocumentModel doc) Static helper to turn a document complex property into a list of RemoteEntity instances suitable to the UI layer.
String	getLabel()
String	getLocalId()
String	getRemoteUri()
String	getType()
boolean	isLocal()
String	toString()
EntitySuggestion	withAutomaticallyCreated(boolean automaticallyCreated)
EntitySuggestion	withScore(double score)

Methods inherited from class java.lang.Object

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

Field Detail

SAMEAS_URI_PROPERTY

public static final String SAMEAS_URI_PROPERTY

See Also:

Constant Field Values

SAMEAS_LABEL_PROPERTY

public static final String SAMEAS_LABEL_PROPERTY

See Also:

Constant Field Values

ALTNAMES_PROPERTY

public static final String ALTNAMES_PROPERTY

See Also:

Constant Field Values

label

public String label

entity

public DocumentModel entity

type

public String type

alternativeNames

public final Set<String> alternativeNames

remoteEntityUris

public final Set<String> remoteEntityUris

score

public double score

automaticallyCreated

public boolean automaticallyCreated

Constructor Detail

EntitySuggestion

public EntitySuggestion(DocumentModel entity)
                 throws ClientException

Throws:

ClientException

EntitySuggestion

public EntitySuggestion(String label,
                String remoteEntityUri,
                String type)

Method Detail

withScore

public EntitySuggestion withScore(double score)

withAutomaticallyCreated

public EntitySuggestion withAutomaticallyCreated(boolean automaticallyCreated)

isLocal

public boolean isLocal()

compareTo

public int compareTo(EntitySuggestion o)

Specified by:

compareTo in interface Comparable<EntitySuggestion>

getLabel

public String getLabel()

getType

public String getType()

getLocalId

public String getLocalId()

Returns:

the id of the local entity or null

getRemoteUri

public String getRemoteUri()

Returns:

the first registered remote URI or null

toString

public String toString()

Overrides:

toString in class Object

fromDocument

public static List<EntitySuggestion> fromDocument(DocumentModel doc)
                                           throws ClientException

Static helper to turn a document complex property into a list of RemoteEntity instances suitable to the UI layer.

Throws:

ClientException