@AlfrescoPublicApi public interface SearchService
Modifier and Type | Field and Description |
---|---|
static String |
LANGUAGE_CMIS_ALFRESCO |
static String |
LANGUAGE_CMIS_STRICT |
static String |
LANGUAGE_FTS_ALFRESCO |
static String |
LANGUAGE_LUCENE |
static String |
LANGUAGE_SOLR_ALFRESCO |
static String |
LANGUAGE_SOLR_CMIS |
static String |
LANGUAGE_SOLR_FTS_ALFRESCO |
static String |
LANGUAGE_SOLR_SQL |
static String |
LANGUAGE_XPATH |
Modifier and Type | Method and Description |
---|---|
boolean |
contains(NodeRef nodeRef,
QName propertyQName,
String googleLikePattern)
Search for string pattern in both the node text (if present) and node
properties
|
boolean |
contains(NodeRef nodeRef,
QName propertyQName,
String googleLikePattern,
SearchParameters.Operator defaultOperator)
Search for string pattern in both the node text (if present) and node
properties
|
boolean |
like(NodeRef nodeRef,
QName propertyQName,
String sqlLikePattern,
boolean includeFTS)
Search for string pattern in both the node text (if present) and node
properties
|
ResultSet |
query(SearchParameters searchParameters)
Search using the given SearchParameters
|
ResultSet |
query(StoreRef store,
QName queryId,
QueryParameter[] queryParameters)
Execute a canned query
|
ResultSet |
query(StoreRef store,
String language,
String query)
Search against a store.
|
ResultSet |
query(StoreRef store,
String language,
String query,
QueryParameterDefinition[] queryParameterDefinitions)
Search against a store.
|
List<NodeRef> |
selectNodes(NodeRef contextNodeRef,
String xpath,
QueryParameterDefinition[] parameters,
NamespacePrefixResolver namespacePrefixResolver,
boolean followAllParentLinks)
Select nodes using an xpath expression.
|
List<NodeRef> |
selectNodes(NodeRef contextNodeRef,
String xpath,
QueryParameterDefinition[] parameters,
NamespacePrefixResolver namespacePrefixResolver,
boolean followAllParentLinks,
String language)
Select nodes using an xpath expression.
|
List<Serializable> |
selectProperties(NodeRef contextNodeRef,
String xpath,
QueryParameterDefinition[] parameters,
NamespacePrefixResolver namespacePrefixResolver,
boolean followAllParentLinks)
Select properties using an xpath expression
|
List<Serializable> |
selectProperties(NodeRef contextNodeRef,
String xpath,
QueryParameterDefinition[] parameters,
NamespacePrefixResolver namespacePrefixResolver,
boolean followAllParentLinks,
String language)
Select properties using an xpath expression
|
static final String LANGUAGE_LUCENE
static final String LANGUAGE_XPATH
static final String LANGUAGE_FTS_ALFRESCO
static final String LANGUAGE_SOLR_FTS_ALFRESCO
static final String LANGUAGE_CMIS_STRICT
static final String LANGUAGE_CMIS_ALFRESCO
static final String LANGUAGE_SOLR_CMIS
static final String LANGUAGE_SOLR_ALFRESCO
static final String LANGUAGE_SOLR_SQL
@Auditable(parameters={"store","language","query"}) ResultSet query(StoreRef store, String language, String query)
store
- -
the store against which to searchlanguage
- -
the query languagequery
- -
the query string - which may include parameters@Auditable(parameters={"store","language","query","queryParameterDefinitions"}) ResultSet query(StoreRef store, String language, String query, QueryParameterDefinition[] queryParameterDefinitions)
store
- -
the store against which to searchlanguage
- -
the query languagequery
- -
the query string - which may include parametersqueryParameterDefinitions
- -
query parameter definitions - the default value is used for
the value.@Auditable(parameters={"store","queryId","queryParameters"}) ResultSet query(StoreRef store, QName queryId, QueryParameter[] queryParameters)
store
- -
the store against which to searchqueryId
- -
the query identifierqueryParameters
- -
parameterisation for the canned query@Auditable(parameters="searchParameters") ResultSet query(SearchParameters searchParameters)
@Auditable(parameters={"contextNodeRef","xpath","parameters","namespacePrefixResolver","followAllParentLinks"}, recordable={true,true,true,false,true}) List<NodeRef> selectNodes(NodeRef contextNodeRef, String xpath, QueryParameterDefinition[] parameters, NamespacePrefixResolver namespacePrefixResolver, boolean followAllParentLinks) throws InvalidNodeRefException, XPathException
contextNodeRef
- -
the context node for relative expressions etcxpath
- -
the xpath string to evaluateparameters
- -
parameters to bind in to the xpath expression, may be null for no parametersnamespacePrefixResolver
- -
prefix to namespace mappingsfollowAllParentLinks
- -
if false ".." follows only the primary parent links, if true
it follows allInvalidNodeRefException
XPathException
@Auditable(parameters={"contextNodeRef","xpath","parameters","namespacePrefixResolver","followAllParentLinks","language"}, recordable={true,true,true,false,true,true}) List<NodeRef> selectNodes(NodeRef contextNodeRef, String xpath, QueryParameterDefinition[] parameters, NamespacePrefixResolver namespacePrefixResolver, boolean followAllParentLinks, String language) throws InvalidNodeRefException, XPathException
contextNodeRef
- -
the context node for relative expressions etcxpath
- -
the xpath string to evaluateparameters
- -
parameters to bind in to the xpath expression, may be null for no parametersnamespacePrefixResolver
- -
prefix to namespace mappingsfollowAllParentLinks
- -
if false ".." follows only the primary parent links, if true
it follows alllanguage
- -
the xpath variantInvalidNodeRefException
XPathException
@Auditable(parameters={"contextNodeRef","xpath","parameters","namespacePrefixResolver","followAllParentLinks"}, recordable={true,true,true,false,true}) List<Serializable> selectProperties(NodeRef contextNodeRef, String xpath, QueryParameterDefinition[] parameters, NamespacePrefixResolver namespacePrefixResolver, boolean followAllParentLinks) throws InvalidNodeRefException, XPathException
contextNodeRef
- -
the context node for relative expressions etcxpath
- -
the xpath string to evaluateparameters
- -
parameters to bind in to the xpath expressionnamespacePrefixResolver
- -
prefix to namespace mappingsfollowAllParentLinks
- -
if false ".." follows only the primary parent links, if true
it follows allInvalidNodeRefException
XPathException
@Auditable(parameters={"contextNodeRef","xpath","parameters","namespacePrefixResolver","followAllParentLinks","language"}, recordable={true,true,true,false,true,true}) List<Serializable> selectProperties(NodeRef contextNodeRef, String xpath, QueryParameterDefinition[] parameters, NamespacePrefixResolver namespacePrefixResolver, boolean followAllParentLinks, String language) throws InvalidNodeRefException, XPathException
contextNodeRef
- -
the context node for relative expressions etcxpath
- -
the xpath string to evaluateparameters
- -
parameters to bind in to the xpath expressionnamespacePrefixResolver
- -
prefix to namespace mappingsfollowAllParentLinks
- -
if false ".." follows only the primary parent links, if true
it follows alllanguage
- -
the xpath variantInvalidNodeRefException
XPathException
@Auditable(parameters={"nodeRef","propertyQName","googleLikePattern"}) boolean contains(NodeRef nodeRef, QName propertyQName, String googleLikePattern) throws InvalidNodeRefException
nodeRef
- the node to getpropertyQName
- the name of the propertygoogleLikePattern
- a Google-like pattern to search for in the property valueInvalidNodeRefException
@Auditable(parameters={"nodeRef","propertyQName","googleLikePattern","defaultOperator"}) boolean contains(NodeRef nodeRef, QName propertyQName, String googleLikePattern, SearchParameters.Operator defaultOperator) throws InvalidNodeRefException
nodeRef
- the node to getpropertyQName
- the name of the propertygoogleLikePattern
- a Google-like pattern to search for in the property valueInvalidNodeRefException
@Auditable(parameters={"nodeRef","propertyQName","sqlLikePattern","includeFTS"}) boolean like(NodeRef nodeRef, QName propertyQName, String sqlLikePattern, boolean includeFTS) throws InvalidNodeRefException
nodeRef
- the node to getpropertyQName
- the name of the property (mandatory)sqlLikePattern
- a SQL-like pattern to search forincludeFTS
- -
include full text search matches in the like testInvalidNodeRefException
Copyright © 2005–2020 Alfresco Software. All rights reserved.