org.alfresco.web.bean.search

Class SearchContext

java.lang.Object

org.alfresco.web.bean.search.SearchContext

All Implemented Interfaces:

Serializable

public class SearchContext
extends Object
implements Serializable

Holds the context required to build a search query and can return the populated query.

Builds a lucene format search string from each of the supplied attributes and terms. Can be serialized to and from XML format for saving and restoring of previous searches.

Author:

Kevin Roast

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	SEARCH_ALL Search mode constants
static int	SEARCH_FILE_NAMES
static int	SEARCH_FILE_NAMES_CONTENTS
static int	SEARCH_SPACE_NAMES
protected List<org.alfresco.service.namespace.QName>	simpleSearchAdditionalAttrs any extra simple query attributes to add to the search

Constructor Summary

Constructors

Constructor and Description
SearchContext()

Method Summary

Modifier and Type	Method and Description
void	addAttributeQuery(org.alfresco.service.namespace.QName qname, String value) Add an additional attribute to search against
void	addFixedValueQuery(org.alfresco.service.namespace.QName qname, String value) Add an additional fixed value attribute to search against
void	addRangeQuery(org.alfresco.service.namespace.QName qname, String lower, String upper, boolean inclusive) Add an additional range attribute to search against
void	addSimpleAttributeQuery(org.alfresco.service.namespace.QName qname) Add an additional attribute to search against for simple searches
String	buildQuery(int minimum) Build the search query string based on the current search context members.
SearchContext	fromXML(String xml) Restore a SearchContext from an XML definition
String	getAttributeQuery(org.alfresco.service.namespace.QName qname)
String[]	getCategories()
String	getContentType()
String	getFixedValueQuery(org.alfresco.service.namespace.QName qname)
String	getFolderType()
boolean	getForceAndTerms()
String	getLocation()
String	getMimeType()
int	getMode()
static String	getPathFromSpaceRef(org.alfresco.service.cmr.repository.NodeRef ref, boolean children) Generate a search XPATH pointing to the specified node, optionally return an XPATH that includes the child nodes.
org.alfresco.web.bean.search.SearchContext.RangeProperties	getRangeProperty(org.alfresco.service.namespace.QName qname)
String	getSearchText()
String	getText()
void	setCategories(String[] categories)
void	setContentType(String contentType)
void	setFolderType(String folderType)
void	setForceAndTerms(boolean forceAndTerms)
void	setLocation(String location)
void	setMimeType(String mimeType)
void	setMode(int mode)
void	setSimpleSearchAdditionalAttributes(List<org.alfresco.service.namespace.QName> attrs) Sets the additional attribute to search against for simple searches.
void	setText(String text)
String	toXML()

Methods inherited from class java.lang.Object

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

Field Detail

SEARCH_ALL

public static final int SEARCH_ALL

Search mode constants

See Also:

Constant Field Values

SEARCH_FILE_NAMES_CONTENTS

public static final int SEARCH_FILE_NAMES_CONTENTS

See Also:

Constant Field Values

SEARCH_FILE_NAMES

public static final int SEARCH_FILE_NAMES

See Also:

Constant Field Values

SEARCH_SPACE_NAMES

public static final int SEARCH_SPACE_NAMES

See Also:

Constant Field Values

simpleSearchAdditionalAttrs

protected List<org.alfresco.service.namespace.QName> simpleSearchAdditionalAttrs

any extra simple query attributes to add to the search

Constructor Detail

SearchContext

public SearchContext()

Method Detail

buildQuery

public String buildQuery(int minimum)

Build the search query string based on the current search context members.

Parameters:

minimum - small possible textual string used for a match this does not effect fixed values searches (e.g. boolean, int values) or date ranges

Returns:

prepared search query string

getPathFromSpaceRef

public static String getPathFromSpaceRef(org.alfresco.service.cmr.repository.NodeRef ref,
                                         boolean children)

Generate a search XPATH pointing to the specified node, optionally return an XPATH that includes the child nodes.

Parameters:

ref - Of the node to generate path too

children - Whether to include children of the node

Returns:

the path

getCategories

public String[] getCategories()

Returns:

Returns the categories to use for the search

setCategories

public void setCategories(String[] categories)

Parameters:

categories - The categories to set as a list of search XPATHs

getLocation

public String getLocation()

Returns:

Returns the node XPath to search in or null for all.

setLocation

public void setLocation(String location)

Parameters:

location - The node XPATH to search from or null for all..

getMode

public int getMode()

Returns:

Returns the mode to use during the search (see constants)

setMode

public void setMode(int mode)

Parameters:

mode - The mode to use during the search (see constants)

getSearchText

public String getSearchText()

getText

public String getText()

Returns:

Returns the search text string.

setText

public void setText(String text)

Parameters:

text - The search text string.

getContentType

public String getContentType()

Returns:

Returns the contentType.

setContentType

public void setContentType(String contentType)

Parameters:

contentType - The content type to restrict attribute search against.

getFolderType

public String getFolderType()

Returns:

Returns the folderType.

setFolderType

public void setFolderType(String folderType)

Parameters:

folderType - The folder type to restrict attribute search against.

getMimeType

public String getMimeType()

Returns:

Returns the mimeType.

setMimeType

public void setMimeType(String mimeType)

Parameters:

mimeType - The mimeType to set.

addSimpleAttributeQuery

public void addSimpleAttributeQuery(org.alfresco.service.namespace.QName qname)

Add an additional attribute to search against for simple searches

Parameters:

qname - QName of the attribute to search against

setSimpleSearchAdditionalAttributes

public void setSimpleSearchAdditionalAttributes(List<org.alfresco.service.namespace.QName> attrs)

Sets the additional attribute to search against for simple searches.

Parameters:

attrs - The list of attributes to search against

addAttributeQuery

public void addAttributeQuery(org.alfresco.service.namespace.QName qname,
                              String value)

Add an additional attribute to search against

Parameters:

qname - QName of the attribute to search against

value - Value of the attribute to use

getAttributeQuery

public String getAttributeQuery(org.alfresco.service.namespace.QName qname)

addRangeQuery

public void addRangeQuery(org.alfresco.service.namespace.QName qname,
                          String lower,
                          String upper,
                          boolean inclusive)

Add an additional range attribute to search against

Parameters:

qname - QName of the attribute to search against

lower - Lower value for range

upper - Upper value for range

inclusive - True for inclusive within the range, false otherwise

getRangeProperty

public org.alfresco.web.bean.search.SearchContext.RangeProperties getRangeProperty(org.alfresco.service.namespace.QName qname)

addFixedValueQuery

public void addFixedValueQuery(org.alfresco.service.namespace.QName qname,
                               String value)

Add an additional fixed value attribute to search against

Parameters:

qname - QName of the attribute to search against

value - Fixed value of the attribute to use

getFixedValueQuery

public String getFixedValueQuery(org.alfresco.service.namespace.QName qname)

getForceAndTerms

public boolean getForceAndTerms()

Returns:

Returns if AND is forced between text terms. False (OR terms) is the default.

setForceAndTerms

public void setForceAndTerms(boolean forceAndTerms)

Parameters:

forceAndTerms - Set true to force AND between text terms. Otherwise OR is the default.

toXML

public String toXML()

Returns:

this SearchContext as XML Example: CDATA int XPath XPath String String String String String String boolean String CDATA

fromXML

public SearchContext fromXML(String xml)

Restore a SearchContext from an XML definition

Parameters:

xml - XML format SearchContext @see #toXML()