org.vertexium.search

Interface SearchIndex

All Known Implementing Classes:

DefaultSearchIndex

public interface SearchIndex

Method Summary

Modifier and Type	Method and Description
void	addElement(Graph graph, Element element, Authorizations authorizations)
void	addElementExtendedData(Graph graph, Element element, Iterable<ExtendedDataMutation> extendedDatas, Authorizations authorizations)
void	addElements(Graph graph, Iterable<? extends Element> elements, Authorizations authorizations)
void	addExtendedData(Graph graph, Iterable<ExtendedDataRow> extendedDatas, Authorizations authorizations)
void	alterElementVisibility(Graph graph, Element element, Visibility oldVisibility, Visibility newVisibility, Authorizations authorizations)
void	clearCache()
void	deleteElement(Graph graph, Element element, Authorizations authorizations)
void	deleteExtendedData(Graph graph, Element element, String tableName, String row, String columnName, String key, Visibility visibility, Authorizations authorizations)
void	deleteExtendedData(Graph graph, ExtendedDataRowId extendedDataRowId, Authorizations authorizations)
default void	deleteProperties(Graph graph, Element element, Collection<PropertyDescriptor> propertyList, Authorizations authorizations) Default delete property simply calls deleteProperty in a loop.
void	deleteProperty(Graph graph, Element element, PropertyDescriptor property, Authorizations authorizations)
void	drop(Graph graph)
void	flush(Graph graph)
SearchIndexSecurityGranularity	getSearchIndexSecurityGranularity()
boolean	isFieldBoostSupported()
boolean	isFieldLevelSecuritySupported()
boolean	isQuerySimilarToTextSupported()
void	markElementHidden(Graph graph, Element element, Visibility visibility, Authorizations authorizations)
void	markElementVisible(Graph graph, Element element, Visibility visibility, Authorizations authorizations)
void	markPropertyHidden(Graph graph, Element element, Property property, Visibility visibility, Authorizations authorizations)
void	markPropertyVisible(Graph graph, Element element, Property property, Visibility visibility, Authorizations authorizations)
Query	queryExtendedData(Graph graph, Element element, String tableName, String queryString, Authorizations authorizations)
MultiVertexQuery	queryGraph(Graph graph, String[] vertexIds, String queryString, Authorizations authorizations)
GraphQuery	queryGraph(Graph graph, String queryString, Authorizations authorizations)
SimilarToGraphQuery	querySimilarTo(Graph graph, String[] fields, String text, Authorizations authorizations)
VertexQuery	queryVertex(Graph graph, Vertex vertex, String queryString, Authorizations authorizations)
void	shutdown()
void	truncate(Graph graph)
<TElement extends Element> void	updateElement(Graph graph, ExistingElementMutation<TElement> mutation, Authorizations authorizations)

Method Detail

addElement

void addElement(Graph graph,
                Element element,
                Authorizations authorizations)

updateElement

<TElement extends Element> void updateElement(Graph graph,
                                              ExistingElementMutation<TElement> mutation,
                                              Authorizations authorizations)

deleteElement

void deleteElement(Graph graph,
                   Element element,
                   Authorizations authorizations)

markElementHidden

void markElementHidden(Graph graph,
                       Element element,
                       Visibility visibility,
                       Authorizations authorizations)

markElementVisible

void markElementVisible(Graph graph,
                        Element element,
                        Visibility visibility,
                        Authorizations authorizations)

markPropertyHidden

void markPropertyHidden(Graph graph,
                        Element element,
                        Property property,
                        Visibility visibility,
                        Authorizations authorizations)

markPropertyVisible

void markPropertyVisible(Graph graph,
                         Element element,
                         Property property,
                         Visibility visibility,
                         Authorizations authorizations)

deleteProperties

default void deleteProperties(Graph graph,
                              Element element,
                              Collection<PropertyDescriptor> propertyList,
                              Authorizations authorizations)

Default delete property simply calls deleteProperty in a loop. It is up to the SearchIndex implementation to decide if a collective method can be made more efficient

deleteProperty

void deleteProperty(Graph graph,
                    Element element,
                    PropertyDescriptor property,
                    Authorizations authorizations)

addElements

void addElements(Graph graph,
                 Iterable<? extends Element> elements,
                 Authorizations authorizations)

queryGraph

GraphQuery queryGraph(Graph graph,
                      String queryString,
                      Authorizations authorizations)

queryGraph

MultiVertexQuery queryGraph(Graph graph,
                            String[] vertexIds,
                            String queryString,
                            Authorizations authorizations)

queryVertex

VertexQuery queryVertex(Graph graph,
                        Vertex vertex,
                        String queryString,
                        Authorizations authorizations)

queryExtendedData

Query queryExtendedData(Graph graph,
                        Element element,
                        String tableName,
                        String queryString,
                        Authorizations authorizations)

querySimilarTo

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

flush

void flush(Graph graph)

shutdown

void shutdown()

clearCache

void clearCache()

isFieldBoostSupported

boolean isFieldBoostSupported()

truncate

void truncate(Graph graph)

drop

void drop(Graph graph)

getSearchIndexSecurityGranularity

SearchIndexSecurityGranularity getSearchIndexSecurityGranularity()

isQuerySimilarToTextSupported

boolean isQuerySimilarToTextSupported()

isFieldLevelSecuritySupported

boolean isFieldLevelSecuritySupported()

alterElementVisibility

void alterElementVisibility(Graph graph,
                            Element element,
                            Visibility oldVisibility,
                            Visibility newVisibility,
                            Authorizations authorizations)

addElementExtendedData

void addElementExtendedData(Graph graph,
                            Element element,
                            Iterable<ExtendedDataMutation> extendedDatas,
                            Authorizations authorizations)

addExtendedData

void addExtendedData(Graph graph,
                     Iterable<ExtendedDataRow> extendedDatas,
                     Authorizations authorizations)

deleteExtendedData

void deleteExtendedData(Graph graph,
                        ExtendedDataRowId extendedDataRowId,
                        Authorizations authorizations)

deleteExtendedData

void deleteExtendedData(Graph graph,
                        Element element,
                        String tableName,
                        String row,
                        String columnName,
                        String key,
                        Visibility visibility,
                        Authorizations authorizations)