org.neolumin.vertexium

Class GraphBaseWithSearchIndex

java.lang.Object

org.neolumin.vertexium.GraphBase

org.neolumin.vertexium.GraphBaseWithSearchIndex

All Implemented Interfaces:

Graph

public abstract class GraphBaseWithSearchIndex
extends GraphBase
implements Graph

Field Summary

Fields

Modifier and Type	Field and Description
static String	METADATA_DEFINE_PROPERTY_PREFIX
static String	METADATA_ID_GENERATOR_CLASSNAME

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	GraphBaseWithSearchIndex(GraphConfiguration configuration, IdGenerator idGenerator, SearchIndex searchIndex)

Method Summary

Methods

Modifier and Type	Method and Description
DefinePropertyBuilder	defineProperty(String propertyName) Creates a defines property builder.
void	flush() Flushes any pending mutations to the graph.
GraphConfiguration	getConfiguration()
IdGenerator	getIdGenerator() Gets the id generator used by this graph to create ids.
SearchIndex	getSearchIndex()
SearchIndexSecurityGranularity	getSearchIndexSecurityGranularity() Gets the granularity of the search index SearchIndexSecurityGranularity
boolean	isFieldBoostSupported() Determine if field boost is support.
boolean	isQuerySimilarToTextSupported()
GraphQuery	query(Authorizations authorizations) Creates a query builder object used to query the graph.
GraphQuery	query(String queryString, Authorizations authorizations) Creates a query builder object used to query the graph.
SimilarToGraphQuery	querySimilarTo(String[] fields, String text, Authorizations authorizations)
void	reindex(Authorizations authorizations) Reindex all vertices and edges.
protected void	reindexVertices(Authorizations authorizations)
protected void	setup()
protected void	setupGraphMetadata()
protected void	setupGraphMetadata(GraphMetadataEntry graphMetadataEntry)
protected void	setupPropertyDefinition(PropertyDefinition propertyDefinition)
void	shutdown() Cleans up or disconnects from the underlying storage.

Methods inherited from class org.neolumin.vertexium.GraphBase

addEdge, addEdge, addEdge, addEdge, addGraphEventListener, addVertex, addVertex, addVertices, doEdgesExist, doesEdgeExist, doesVertexExist, doVerticesExist, findPaths, findPaths, findPaths, findPaths, findRelatedEdges, fireGraphEvent, getEdge, getEdge, getEdges, getEdges, getEdges, getEdges, getMetadata, getMetadata, getVertex, getVertex, getVertices, getVertices, getVertices, getVertices, getVerticesInOrder, getVerticesInOrder, hasEventListeners, prepareEdge, prepareEdge, prepareVertex, removeEdge, removeEdge, removeVertex, setMetadata

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.neolumin.vertexium.Graph

addEdge, addEdge, addEdge, addEdge, addGraphEventListener, addVertex, addVertex, addVertices, clearData, createAuthorizations, doEdgesExist, doesEdgeExist, doesVertexExist, doVerticesExist, findPaths, findPaths, findPaths, findPaths, findRelatedEdges, getEdge, getEdge, getEdges, getEdges, getEdges, getEdges, getMetadata, getMetadata, getVertex, getVertex, getVertices, getVertices, getVertices, getVertices, getVerticesInOrder, getVerticesInOrder, isVisibilityValid, markEdgeHidden, markEdgeVisible, markVertexHidden, markVertexVisible, prepareEdge, prepareEdge, prepareEdge, prepareEdge, prepareVertex, prepareVertex, removeEdge, removeEdge, removeVertex, setMetadata

Field Detail

METADATA_DEFINE_PROPERTY_PREFIX

public static final String METADATA_DEFINE_PROPERTY_PREFIX

See Also:

Constant Field Values

METADATA_ID_GENERATOR_CLASSNAME

public static final String METADATA_ID_GENERATOR_CLASSNAME

See Also:

Constant Field Values

Constructor Detail

GraphBaseWithSearchIndex

protected GraphBaseWithSearchIndex(GraphConfiguration configuration,
                        IdGenerator idGenerator,
                        SearchIndex searchIndex)

Method Detail

setup

protected void setup()

setupGraphMetadata

protected void setupGraphMetadata()

setupGraphMetadata

protected void setupGraphMetadata(GraphMetadataEntry graphMetadataEntry)

setupPropertyDefinition

protected void setupPropertyDefinition(PropertyDefinition propertyDefinition)

query

public GraphQuery query(Authorizations authorizations)

Description copied from interface: Graph

Creates a query builder object used to query the graph.

Specified by:

query in interface Graph

Specified by:

query in class GraphBase

Parameters:

authorizations - The authorizations required to load the elements.

Returns:

A query builder object.

query

public GraphQuery query(String queryString,
               Authorizations authorizations)

Description copied from interface: Graph

Creates a query builder object used to query the graph.

Specified by:

query in interface Graph

Specified by:

query in class GraphBase

Parameters:

queryString - The string to search for in the text of an element. This will search all fields for the given text.

authorizations - The authorizations required to load the elements.

Returns:

A query builder object.

isQuerySimilarToTextSupported

public boolean isQuerySimilarToTextSupported()

Specified by:

isQuerySimilarToTextSupported in interface Graph

Overrides:

isQuerySimilarToTextSupported in class GraphBase

querySimilarTo

public SimilarToGraphQuery querySimilarTo(String[] fields,
                                 String text,
                                 Authorizations authorizations)

Specified by:

querySimilarTo in interface Graph

Overrides:

querySimilarTo in class GraphBase

getIdGenerator

public IdGenerator getIdGenerator()

Description copied from interface: Graph

Gets the id generator used by this graph to create ids.

Specified by:

getIdGenerator in interface Graph

Returns:

the id generator.

getConfiguration

public GraphConfiguration getConfiguration()

getSearchIndex

public SearchIndex getSearchIndex()

reindex

public void reindex(Authorizations authorizations)

Description copied from interface: Graph

Reindex all vertices and edges.

Specified by:

reindex in interface Graph

Specified by:

reindex in class GraphBase

Parameters:

authorizations - authorizations used to query for the data to reindex.

reindexVertices

protected void reindexVertices(Authorizations authorizations)

flush

public void flush()

Description copied from interface: Graph

Flushes any pending mutations to the graph.

Specified by:

flush in interface Graph

Specified by:

flush in class GraphBase

shutdown

public void shutdown()

Description copied from interface: Graph

Cleans up or disconnects from the underlying storage.

Specified by:

shutdown in interface Graph

Specified by:

shutdown in class GraphBase

defineProperty

public DefinePropertyBuilder defineProperty(String propertyName)

Description copied from interface: Graph

Creates a defines property builder. This is typically used by the indexer to give it hints on how it should index a property.

Specified by:

defineProperty in interface Graph

Specified by:

defineProperty in class GraphBase

Parameters:

propertyName - The name of the property to define.

isFieldBoostSupported

public boolean isFieldBoostSupported()

Description copied from interface: Graph

Determine if field boost is support. That is can you change the boost at a field level to give higher priority.

Specified by:

isFieldBoostSupported in interface Graph

Specified by:

isFieldBoostSupported in class GraphBase

getSearchIndexSecurityGranularity

public SearchIndexSecurityGranularity getSearchIndexSecurityGranularity()

Description copied from interface: Graph

Gets the granularity of the search index SearchIndexSecurityGranularity

Specified by:

getSearchIndexSecurityGranularity in interface Graph

Specified by:

getSearchIndexSecurityGranularity in class GraphBase