* 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 final class Search extends BaseScriptImplementation implements Scopeable
{
/** Service registry */
private ServiceRegistry services;
/** Default store reference */
private StoreRef storeRef;
/** Root scope for this object */
private Scriptable scope;
/**
* Set the default store reference
*
* @param storeRef the default store reference
*/
public void setStoreUrl(String storeRef)
{
this.storeRef = new StoreRef(storeRef);
}
/**
* Set the service registry
*
* @param services the service registry
*/
public void setServiceRegistry(ServiceRegistry services)
{
this.services = services;
}
/**
* @see org.alfresco.repo.jscript.Scopeable#setScope(org.mozilla.javascript.Scriptable)
*/
public void setScope(Scriptable scope)
{
this.scope = scope;
}
/**
* 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 Node findNode(NodeRef ref)
{
return findNode(ref.toString());
}
/**
* 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 Node findNode(String ref)
{
String query = "ID:" + LuceneQueryParser.escape(ref);
Node[] result = query(query, SearchService.LANGUAGE_LUCENE);
if (result.length == 1)
{
return result[0];
}
else
{
return null;
}
}
/**
* Execute a XPath search
*
* @param search XPath search string to execute
*
* @return Node[] of results from the search - can be empty but not null
*/
public Node[] xpathSearch(String search)
{
if (search != null && search.length() != 0)
{
return query(search, SearchService.LANGUAGE_XPATH);
}
else
{
return new Node[0];
}
}
/**
* Execute a Lucene search
*
* @param search Lucene search string to execute
*
* @return Node[] of results from the search - can be empty but not null
*/
public Node[] luceneSearch(String search)
{
if (search != null && search.length() != 0)
{
return query(search, SearchService.LANGUAGE_LUCENE);
}
else
{
return new Node[0];
}
}
/**
* Execute a saved Lucene search
*
* @param savedSearch Node that contains the saved search XML content
*
* @return Node[] of results from the search - can be empty but not null
*/
public Node[] savedSearch(Node 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);
}
return search != null ? query(search, SearchService.LANGUAGE_LUCENE) : new Node[0];
}
/**
* Execute a saved Lucene search
*
* @param searchRef NodeRef string that points to the node containing saved search XML content
*
* @return Node[] of results from the search - can be empty but not null
*/
public Node[] savedSearch(String searchRef)
{
if (searchRef != null)
{
return savedSearch(new Node(new NodeRef(searchRef), services, null));
}
else
{
return new Node[0];
}
}
/**
* Execute the query
*
* Removes any duplicates that may be present (ID can cause duplicates - it is better to remove them here)
*
* @param search
* @return
*/
private Node[] query(String search, String language)
{
LinkedHashSet