SearchCriteria (Jahia Server Implementation 8.0.0.0 API)

java.lang.Object
- org.jahia.services.search.SearchCriteria

All Implemented Interfaces:

Serializable
```
public class SearchCriteria
extends Object
implements Serializable
```
Bean for holding all search parameters.

Author:

Sergiy Shyrkov

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`SearchCriteria.BaseFacetDefinition` Base class for all facet definitions; encapsulates any common facet definition attributes like sort order of aggregated results.
`static class`	`SearchCriteria.CommaSeparatedMultipleValue` Supports comma separated multiple values.
`static class`	`SearchCriteria.DateValue` Holder for the criterion of date type.
`static class`	`SearchCriteria.FacetValue`
`static class`	`SearchCriteria.HierarchicalValue` Represents a selactable value (file location, category etc.) that is a part of the hierarchical structure.
`static class`	`SearchCriteria.MultipleValue` Represents a multiple value holder.
`static class`	`SearchCriteria.NodeProperty` Single search criterion on the node property.
`static class`	`SearchCriteria.NodePropertyDescriptor` Contains description of the node property.
`protected static class`	`SearchCriteria.NodePropertyFactory`
`protected static class`	`SearchCriteria.NodePropertyMapFactory`
`static class`	`SearchCriteria.Ordering` Represents an ordering definition
`static class`	`SearchCriteria.Term` Single text search criterion with a search text and match type.

Constructor Summary

Constructors
Constructor and Description

SearchCriteria()
Initializes an instance of this class.

Constructors
Constructor and Description
`SearchCriteria()` Initializes an instance of this class.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`SearchCriteria.DateValue`	`getCreated()`
`String`	`getCreatedBy()`
`Collection<SearchCriteria.BaseFacetDefinition>`	`getFacetDefinitions()`
`Map<String,Map<String,SearchCriteria.FacetValue>>`	`getFacets()` Return active facet filters.
`SearchCriteria.HierarchicalValue`	`getFilePath()`
`String`	`getFileType()`
`int`	`getItemsPerPage()`
`SearchCriteria.CommaSeparatedMultipleValue`	`getLanguages()`
`SearchCriteria.DateValue`	`getLastModified()`
`String`	`getLastModifiedBy()`
`long`	`getLimit()` Returns the maximum hit count to be returned.
`String`	`getNodeType()`
`long`	`getOffset()` Returns the start offset of the search hit list.
`List<SearchCriteria.Ordering>`	`getOrderings()`
`String`	`getOriginSiteKey()` Returns the origin site key, i.e.
`SearchCriteria.HierarchicalValue`	`getPagePath()`
`Map<String,Map<String,SearchCriteria.NodeProperty>>`	`getProperties()`
`List<SearchCriteria.NodeProperty>`	`getPropertiesAll()`
`String`	`getRawQuery()` Deprecated. Not implemented
`SearchCriteria.CommaSeparatedMultipleValue`	`getSites()`
`SearchCriteria.CommaSeparatedMultipleValue`	`getSitesForReferences()`
`List<SearchCriteria.Term>`	`getTerms()`
`int`	`hashCode()`
`boolean`	`isEmpty()` Returns `true` if none of required search parameters was specified; otherwise returns `false`.
`boolean`	`isExcludeFileReferences()` Indicates if file references in site content are excluded from search results.
`boolean`	`isFileSearch()` Checks if this search criteria represents a file search.
`boolean`	`isSiteSearch()` Checks if this search criteria represents a site content search.
`void`	`setCreated(SearchCriteria.DateValue creationDate)`
`void`	`setCreatedBy(String author)`
`void`	`setExcludeFileReferences(boolean excludeFileReferences)` Instruct the search provider how to handle the file references in site content.
`void`	`setFacetDefinitions(Collection<SearchCriteria.BaseFacetDefinition> facetDefinitions)`
`void`	`setFacets(Map<String,Map<String,SearchCriteria.FacetValue>> facets)` Sets the active facet filters.
`void`	`setFilePath(SearchCriteria.HierarchicalValue fileLocation)`
`void`	`setFileType(String fileType)`
`void`	`setItemsPerPage(int itemsPerPage)`
`void`	`setLanguages(SearchCriteria.CommaSeparatedMultipleValue languages)`
`void`	`setLastModified(SearchCriteria.DateValue lastModificationDate)`
`void`	`setLastModifiedBy(String lastEditor)`
`void`	`setLimit(long limit)` Sets the maximum size of the result set to `limit`.
`void`	`setNodeType(String nodeType)`
`void`	`setOffset(long offset)` Sets the start offset of the result set to `offset`.
`void`	`setOrderings(List<SearchCriteria.Ordering> orderings)`
`void`	`setOriginSiteKey(String originSiteKey)` Sets the origin site key, i.e.
`void`	`setPagePath(SearchCriteria.HierarchicalValue pagePath)`
`void`	`setProperties(Map<String,Map<String,SearchCriteria.NodeProperty>> properties)`
`void`	`setRawQuery(String rawQuery)` Deprecated. Not implemented
`void`	`setSites(SearchCriteria.CommaSeparatedMultipleValue sites)`
`void`	`setSitesForReferences(SearchCriteria.CommaSeparatedMultipleValue sitesForReferences)`
`void`	`setTerm(String term)` Simplified method for setting the search term.
`void`	`setTerms(List<SearchCriteria.Term> textSearches)`
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - SearchCriteria
```
public SearchCriteria()
```
    Initializes an instance of this class.
- Method Detail
  - getCreated
```
public SearchCriteria.DateValue getCreated()
```
  - getCreatedBy
```
public String getCreatedBy()
```
  - getFacetDefinitions
```
public Collection<SearchCriteria.BaseFacetDefinition> getFacetDefinitions()
```
  - getFacets
```
public Map<String,Map<String,SearchCriteria.FacetValue>> getFacets()
```
    Return active facet filters.
    
    Returns:
    
    active facet filters
  - getFilePath
```
public SearchCriteria.HierarchicalValue getFilePath()
```
  - getFileType
```
public String getFileType()
```
  - getItemsPerPage
```
public int getItemsPerPage()
```
  - getLanguages
```
public SearchCriteria.CommaSeparatedMultipleValue getLanguages()
```
  - getLastModified
```
public SearchCriteria.DateValue getLastModified()
```
  - getLastModifiedBy
```
public String getLastModifiedBy()
```
  - getLimit
```
public long getLimit()
```
    Returns the maximum hit count to be returned. If the limit was not set, returns 0.
    
    Returns:
    
    the maximum hit count to be returned. If the limit was not set, returns 0
  - getNodeType
```
public String getNodeType()
```
  - getOffset
```
public long getOffset()
```
    Returns the start offset of the search hit list. If the offset was not set, returns 0.
    
    Returns:
    
    the start offset of the search hit list. If the offset was not set, returns 0
  - getOriginSiteKey
```
public String getOriginSiteKey()
```
    Returns the origin site key, i.e. the key of the "current" site, where the query was executed from. This value is used for example to resolve the tag by its name as tags are site-specific.
    
    Returns:
    
    the originSiteKey the origin site key, i.e. the key of the "current" site, where the query was executed from. This value is used for example to resolve the tag by its name as tags are site-specific.
  - getPagePath
```
public SearchCriteria.HierarchicalValue getPagePath()
```
  - getProperties
```
public Map<String,Map<String,SearchCriteria.NodeProperty>> getProperties()
```
  - getPropertiesAll
```
public List<SearchCriteria.NodeProperty> getPropertiesAll()
```
  - getRawQuery
```
@Deprecated
public String getRawQuery()
```
    Deprecated. Not implemented
  - getSites
```
public SearchCriteria.CommaSeparatedMultipleValue getSites()
```
  - getSitesForReferences
```
public SearchCriteria.CommaSeparatedMultipleValue getSitesForReferences()
```
  - getTerms
```
public List<SearchCriteria.Term> getTerms()
```
  - getOrderings
```
public List<SearchCriteria.Ordering> getOrderings()
```
  - isEmpty
```
public boolean isEmpty()
```
    Returns true if none of required search parameters was specified; otherwise returns false.
    
    Returns:
    
    true if none of required search parameters was specified; otherwise returns false
  - setCreated
```
public void setCreated(SearchCriteria.DateValue creationDate)
```
  - setCreatedBy
```
public void setCreatedBy(String author)
```
  - setFacetDefinitions
```
public void setFacetDefinitions(Collection<SearchCriteria.BaseFacetDefinition> facetDefinitions)
```
  - setFacets
```
public void setFacets(Map<String,Map<String,SearchCriteria.FacetValue>> facets)
```
    Sets the active facet filters.
    
    Parameters:
    
    facets - the active facet filters
  - setFilePath
```
public void setFilePath(SearchCriteria.HierarchicalValue fileLocation)
```
  - setFileType
```
public void setFileType(String fileType)
```
  - setItemsPerPage
```
public void setItemsPerPage(int itemsPerPage)
```
  - setLanguages
```
public void setLanguages(SearchCriteria.CommaSeparatedMultipleValue languages)
```
  - setLastModified
```
public void setLastModified(SearchCriteria.DateValue lastModificationDate)
```
  - setLastModifiedBy
```
public void setLastModifiedBy(String lastEditor)
```
  - setLimit
```
public void setLimit(long limit)
```
    Sets the maximum size of the result set to limit.
    
    Parameters:
    
    limit - the maximum hot count to be returned
  - setNodeType
```
public void setNodeType(String nodeType)
```
  - setOffset
```
public void setOffset(long offset)
```
    Sets the start offset of the result set to offset.
    
    Parameters:
    
    offset - the start offset of the search hit list
  - setOriginSiteKey
```
public void setOriginSiteKey(String originSiteKey)
```
    Sets the origin site key, i.e. the key of the "current" site, where the query was executed from. This value is used for example to resolve the tag by its name as tags are site-specific.
    
    Parameters:
    
    originSiteKey - the origin site key, i.e. the key of the "current" site, where the query was executed from. This value is used for example to resolve the tag by its name as tags are site-specific.
  - setPagePath
```
public void setPagePath(SearchCriteria.HierarchicalValue pagePath)
```
  - setProperties
```
public void setProperties(Map<String,Map<String,SearchCriteria.NodeProperty>> properties)
```
  - setRawQuery
```
@Deprecated
public void setRawQuery(String rawQuery)
```
    Deprecated. Not implemented
  - setSites
```
public void setSites(SearchCriteria.CommaSeparatedMultipleValue sites)
```
  - setSitesForReferences
```
public void setSitesForReferences(SearchCriteria.CommaSeparatedMultipleValue sitesForReferences)
```
  - setTerm
```
public void setTerm(String term)
```
    Simplified method for setting the search term. This method resets all text searches, creates a new one with the provided term, default match type and all search fields.
    
    Parameters:
    
    term - the search term string
  - setTerms
```
public void setTerms(List<SearchCriteria.Term> textSearches)
```
  - setOrderings
```
public void setOrderings(List<SearchCriteria.Ordering> orderings)
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - isFileSearch
```
public boolean isFileSearch()
```
    Checks if this search criteria represents a file search.
    
    Returns:
    
    true if this search criteria represents file search; false otherwise
  - isSiteSearch
```
public boolean isSiteSearch()
```
    Checks if this search criteria represents a site content search.
    
    Returns:
    
    true if this search criteria represents site search; false otherwise
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - isExcludeFileReferences
```
public boolean isExcludeFileReferences()
```
    Indicates if file references in site content are excluded from search results. Note, please, that the handling of this flag is search provider specific. The default JCR provider considers this flag (including referenced files by default in search results). Some providers may completely ignore this setting and exclude file references in any case.
    
    Returns:
    
    the excludeFileReferences true, if file references in site content are excluded from search results; false otherwise
  - setExcludeFileReferences
```
public void setExcludeFileReferences(boolean excludeFileReferences)
```
    Instruct the search provider how to handle the file references in site content. Note, please, the handling of this flag is optional for a search provider. Default JCR search provider considers it, others may ignore it completely.
    
    Parameters:
    
    excludeFileReferences - true to exclude file references in the content from search results; false - to include them.

Class SearchCriteria

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SearchCriteria

Method Detail

getCreated

getCreatedBy

getFacetDefinitions

getFacets

getFilePath

getFileType

getItemsPerPage

getLanguages

getLastModified

getLastModifiedBy

getLimit

getNodeType

getOffset

getOriginSiteKey

getPagePath

getProperties

getPropertiesAll

getRawQuery

getSites

getSitesForReferences

getTerms

getOrderings

isEmpty

setCreated

setCreatedBy

setFacetDefinitions

setFacets

setFilePath

setFileType

setItemsPerPage

setLanguages

setLastModified

setLastModifiedBy

setLimit

setNodeType

setOffset

setOriginSiteKey

setPagePath

setProperties

setRawQuery

setSites

setSitesForReferences

setTerm

setTerms

setOrderings

toString

isFileSearch

isSiteSearch

hashCode

equals

isExcludeFileReferences

setExcludeFileReferences