org.visallo.core.model.termMention

Class TermMentionBuilder

java.lang.Object

org.visallo.core.model.termMention.TermMentionBuilder

public class TermMentionBuilder
extends Object

Constructor Summary

Constructors

Constructor and Description
TermMentionBuilder()
TermMentionBuilder(org.vertexium.Vertex existingTermMention, org.vertexium.Vertex outVertex) Copy an existing term mention.

Method Summary

Modifier and Type	Method and Description
TermMentionBuilder	conceptIri(String conceptIri) The concept type of this term mention.
TermMentionBuilder	end(long end) The end offset within the property text that this term mention appears.
TermMentionBuilder	outVertex(org.vertexium.Vertex outVertex) The vertex that contains this term mention (ie Document, Html page, etc).
TermMentionBuilder	process(String process) The process that created this term mention.
TermMentionBuilder	propertyKey(String propertyKey) The property key of the VisalloProperties.TEXT that this term mention references.
TermMentionBuilder	propertyName(String propertyName) The property name of the VisalloProperties.TEXT that this term mention references.
TermMentionBuilder	resolvedTo(String resolvedToVertexId, String resolvedEdgeId) If this is a resolved term mention.
TermMentionBuilder	resolvedTo(org.vertexium.Vertex resolvedToVertex, org.vertexium.Edge resolvedEdge) If this is a resolved term mention.
org.vertexium.Vertex	save(org.vertexium.Graph graph, VisibilityTranslator visibilityTranslator, User user, org.vertexium.Authorizations authorizations) Saves the term mention to the graph.
TermMentionBuilder	snippet(String snippet)
TermMentionBuilder	start(long start) The start offset within the property text that this term mention appears.
TermMentionBuilder	title(String title) The title/text of this term mention.
TermMentionBuilder	visibilityJson(String visibilityJsonString) Visibility JSON string.
TermMentionBuilder	visibilityJson(VisibilityJson visibilitySource) Visibility JSON object.

Methods inherited from class java.lang.Object

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

Constructor Detail

TermMentionBuilder

public TermMentionBuilder()

TermMentionBuilder

public TermMentionBuilder(org.vertexium.Vertex existingTermMention,
                          org.vertexium.Vertex outVertex)

Copy an existing term mention.

Parameters:

existingTermMention - The term mention you would like to copy.

outVertex - The vertex that contains this term mention (ie Document, Html page, etc).

Method Detail

start

public TermMentionBuilder start(long start)

The start offset within the property text that this term mention appears.

end

public TermMentionBuilder end(long end)

The end offset within the property text that this term mention appears.

propertyKey

public TermMentionBuilder propertyKey(String propertyKey)

The property key of the VisalloProperties.TEXT that this term mention references.

propertyName

public TermMentionBuilder propertyName(String propertyName)

The property name of the VisalloProperties.TEXT that this term mention references.

visibilityJson

public TermMentionBuilder visibilityJson(String visibilityJsonString)

Visibility JSON string. This will be applied to the newly created term.

visibilityJson

public TermMentionBuilder visibilityJson(VisibilityJson visibilitySource)

Visibility JSON object. This will be applied to the newly created term.

resolvedTo

public TermMentionBuilder resolvedTo(org.vertexium.Vertex resolvedToVertex,
                                     org.vertexium.Edge resolvedEdge)

If this is a resolved term mention. This allows setting that information.

Parameters:

resolvedToVertex - The vertex this term mention resolves to.

resolvedEdge - The edge that links the source vertex to the resolved vertex.

resolvedTo

public TermMentionBuilder resolvedTo(String resolvedToVertexId,
                                     String resolvedEdgeId)

If this is a resolved term mention. This allows setting that information.

Parameters:

resolvedToVertexId - The vertex id this term mention resolves to.

resolvedEdgeId - The edge id that links the source vertex to the resolved vertex.

process

public TermMentionBuilder process(String process)

The process that created this term mention.

outVertex

public TermMentionBuilder outVertex(org.vertexium.Vertex outVertex)

The vertex that contains this term mention (ie Document, Html page, etc).

title

public TermMentionBuilder title(String title)

The title/text of this term mention. (ie Job Ferner, Paris, etc).

snippet

public TermMentionBuilder snippet(String snippet)

conceptIri

public TermMentionBuilder conceptIri(String conceptIri)

The concept type of this term mention.

save

public org.vertexium.Vertex save(org.vertexium.Graph graph,
                                 VisibilityTranslator visibilityTranslator,
                                 User user,
                                 org.vertexium.Authorizations authorizations)

Saves the term mention to the graph.

The resulting graph for non-resolved terms will be:

Source -- Has --> Term Vertex Mention

The resulting graph for resolved terms will be:

Source -- Has --> Term -- Resolved To --> Resolved Vertex Mention Vertex