* Provides access to Lucene search facilities including saved search objects. The results * from a search are returned as an array (collection) of scriptable Node wrapper objects. *
* The object is added to the root of the model to provide syntax such as:
* var results = search.luceneSearch(statement);
* and
* var results = search.savedSearch(node);
*
* @author Kevin Roast
*/
public class Search extends BaseScopableProcessorExtension
{
/** Service registry */
protected ServiceRegistry services;
/** Default store reference */
protected StoreRef storeRef;
/** Repository helper */
protected Repository repository;
/**
* Set the default store reference
*
* @param storeRef the default store reference
*/
public void setStoreUrl(String storeRef)
{
// ensure this is not set again by a script instance!
if (this.storeRef != null)
{
throw new IllegalStateException("Default store URL can only be set once.");
}
this.storeRef = new StoreRef(storeRef);
}
/**
* Set the service registry
*
* @param services the service registry
*/
public void setServiceRegistry(ServiceRegistry services)
{
this.services = services;
}
/**
* Set the repository helper
*
* @param repository the repository helper
*/
public void setRepositoryHelper(Repository repository)
{
this.repository = repository;
}
// JavaScript API
/**
* Find a single Node by the Node reference
*
* @param ref The NodeRef of the Node to find
*
* @return the Node if found or null if failed to find
*/
public ScriptNode findNode(NodeRef ref)
{
ParameterCheck.mandatory("ref", ref);
String query = "ID:" + LuceneQueryParser.escape(ref.toString());
Object[] result = query(ref.getStoreRef().toString(), query, null, SearchService.LANGUAGE_LUCENE);
if (result.length != 0)
{
return (ScriptNode)result[0];
}
else
{
return null;
}
}
/**
* Find a single Node by the Node reference
*
* @param ref The fully qualified NodeRef in String format
*
* @return the Node if found or null if failed to find
*/
public ScriptNode findNode(String ref)
{
ParameterCheck.mandatoryString("ref", ref);
return findNode(new NodeRef(ref));
}
/**
* Helper to convert a Web Script Request URL to a Node Ref
*
* 1) Node - {store_type}/{store_id}/{node_id}
*
* Resolve to node via its Node Reference.
*
* 2) Path - {store_type}/{store_id}/{path}
*
* Resolve to node via its display path.
*
* 3) AVM Path - {store_id}/{path}
*
* Resolve to AVM node via its display path
*
* 4) QName - {store_type}/{store_id}/{child_qname_path}
*
* Resolve to node via its child qname path.
*
* @param referenceType one of node, path, avmpath or qname
* @param reference array of reference segments (as described above for each reference type)
* @return ScriptNode the script node
*/
public ScriptNode findNode(String referenceType, String[] reference)
{
ParameterCheck.mandatoryString("referenceType", referenceType);
ParameterCheck.mandatory("reference", reference);
ScriptNode result = null;
NodeRef nodeRef = this.repository.findNodeRef(referenceType, reference);
if (nodeRef != null)
{
result = new ScriptNode(nodeRef, this.services, getScope());
}
return result;
}
/**
* Execute a XPath search
*
* @param search XPath search string to execute
*
* @return JavaScript array of Node results from the search - can be empty but not null
*/
public Scriptable xpathSearch(String search)
{
return xpathSearch(null, search);
}
/**
* Execute a XPath search
*
* @param store Store reference to search against i.e. workspace://SpacesStore
* @param search XPath search string to execute
*
* @return JavaScript array of Node results from the search - can be empty but not null
*/
public Scriptable xpathSearch(String store, String search)
{
if (search != null && search.length() != 0)
{
Object[] results = query(store, search, null, SearchService.LANGUAGE_XPATH);
return Context.getCurrentContext().newArray(getScope(), results);
}
else
{
return Context.getCurrentContext().newArray(getScope(), 0);
}
}
/**
* Validation Xpath query
*
* @param query xpath query
* @return true if xpath query valid
*/
public boolean isValidXpathQuery(String query)
{
try
{
XPathReader reader = new XPathReader();
reader.parse(query);
}
catch (Exception e)
{
return false;
}
return true;
}
/**
* Execute a Lucene search
*
* @param search Lucene search string to execute
*
* @return JavaScript array of Node results from the search - can be empty but not null
*/
public Scriptable luceneSearch(String search)
{
return luceneSearch(null, search);
}
/**
* Execute a Lucene search
*
* @param store Store reference to search against i.e. workspace://SpacesStore
* @param search Lucene search string to execute
*
* @return JavaScript array of Node results from the search - can be empty but not null
*/
public Scriptable luceneSearch(String store, String search)
{
if (search != null && search.length() != 0)
{
Object[] results = query(store, search, null, SearchService.LANGUAGE_LUCENE);
return Context.getCurrentContext().newArray(getScope(), results);
}
else
{
return Context.getCurrentContext().newArray(getScope(), 0);
}
}
/**
* Execute a Lucene search (sorted)
*
* @param search Lucene search string to execute
* @param sortKey property name to sort on
* @param asc true => ascending sort
*
* @return JavaScript array of Node results from the search - can be empty but not null
*/
public Scriptable luceneSearch(String search, String sortColumn, boolean asc)
{
return luceneSearch(null, search, sortColumn, asc, 0);
}
public Scriptable luceneSearch(String search, String sortColumn, boolean asc, int max)
{
return luceneSearch(null, search, sortColumn, asc, max);
}
public Scriptable luceneSearch(String store, String search, String sortColumn, boolean asc)
{
return luceneSearch(store, search, sortColumn, asc, 0);
}
/**
* Execute a Lucene search (sorted)
*
* @param store Store reference to search against i.e. workspace://SpacesStore
* @param search Lucene search string to execute
* @param sortKey property name to sort on
* @param asc true => ascending sort
*
* @return JavaScript array of Node results from the search - can be empty but not null
*/
public Scriptable luceneSearch(String store, String search, String sortColumn, boolean asc, int max)
{
if (search == null || search.length() == 0)
{
return Context.getCurrentContext().newArray(getScope(), 0);
}
SortColumn[] sort = null;
if (sortColumn != null && sortColumn.length() != 0)
{
sort = new SortColumn[1];
sort[0] = new SortColumn(sortColumn, asc);
}
Object[] results = query(store, search, sort, SearchService.LANGUAGE_LUCENE, max, 0);
return Context.getCurrentContext().newArray(getScope(), results);
}
/**
* Execute a saved Lucene search
*
* @param savedSearch Node that contains the saved search XML content
*
* @return JavaScript array of Node results from the search - can be empty but not null
*/
public Scriptable savedSearch(ScriptNode savedSearch)
{
String search = null;
// read the Saved Search XML on the specified node - and get the Lucene search from it
try
{
if (savedSearch != null)
{
ContentReader content = this.services.getContentService().getReader(
savedSearch.getNodeRef(), ContentModel.PROP_CONTENT);
if (content != null && content.exists())
{
// get the root element
SAXReader reader = new SAXReader();
Document document = reader.read(new StringReader(content.getContentString()));
Element rootElement = document.getRootElement();
Element queryElement = rootElement.element("query");
if (queryElement != null)
{
search = queryElement.getText();
}
}
}
}
catch (Throwable err)
{
throw new AlfrescoRuntimeException("Failed to find or load saved Search: " + savedSearch.getNodeRef(), err);
}
if (search != null)
{
Object[] results = query(null, search, null, SearchService.LANGUAGE_LUCENE);
return Context.getCurrentContext().newArray(getScope(), results);
}
else
{
return Context.getCurrentContext().newArray(getScope(), 0);
}
}
/**
* Execute a saved Lucene search
*
* @param searchRef NodeRef string that points to the node containing saved search XML content
*
* @return JavaScript array of Node results from the search - can be empty but not null
*/
public Scriptable savedSearch(String searchRef)
{
if (searchRef != null)
{
return savedSearch(new ScriptNode(new NodeRef(searchRef), services, null));
}
else
{
return Context.getCurrentContext().newArray(getScope(), 0);
}
}
/**
* Searchs the store for all nodes with the given tag applied.
*
* @param store store ref string, default used if null provided
* @param tag tag name
* @return ScriptNode[] nodes with tag applied
*/
public ScriptNode[] tagSearch(String store, String tag)
{
StoreRef searchStoreRef = null;
if (store != null)
{
searchStoreRef = new StoreRef(store);
}
else
{
searchStoreRef = this.storeRef;
}
List
* search
* {
* query: string, mandatory, in appropriate format and encoded for the given language
* store: string, optional, defaults to 'workspace://SpacesStore'
* language: string, optional, one of: lucene, xpath, jcr-xpath, fts-alfresco - defaults to 'lucene'
* templates: [], optional, Array of query language template objects (see below) - if supported by the language
* sort: [], optional, Array of sort column objects (see below) - if supported by the language
* page: object, optional, paging information object (see below) - if supported by the language
* namespace: string optional, the default namespace for properties
* }
*
* sort
* {
* column: string, mandatory, sort column in appropriate format for the language
* ascending: boolean optional, defaults to false
* }
*
* page
* {
* maxItems: int, optional, max number of items to return in result set
* skipCount: int optional, number of items to skip over before returning results
* }
*
* template
* {
* field: string, mandatory, custom field name for the template
* template: string mandatory, query template replacement for the template
* }
*
* Note that only some query languages support custom query templates, such as 'fts-alfresco'.
* See the following documentation for more details:
* {@link http://wiki.alfresco.com/wiki/Full_Text_Search_Query_Syntax#Templates}
*
*
* @param search Search definition object as above
*
* @return Array of ScriptNode results
*/
public Scriptable query(Object search)
{
Object[] results = null;
if (search instanceof Serializable)
{
Serializable obj = new ValueConverter().convertValueForRepo((Serializable)search);
if (obj instanceof Map)
{
Map