com.logicaldoc.web.search
Class SearchForm

java.lang.Object
  com.logicaldoc.web.components.SortableList
      com.logicaldoc.web.search.SearchForm

public class SearchForm
extends SortableList

A simple search form bean.

Since:

2.7

Author:

Marco Meschieri - Logical Objects

Field Summary

protected static org.apache.commons.logging.Log

logger

Constructor Summary

SearchForm()

Method Summary

java.lang.String	advanced() Shows the advanced search form.
void	cancelFolderSelector(javax.faces.event.ActionEvent e)
void	changeTemplate(javax.faces.event.ValueChangeEvent event)
void	closeFolderSelector(javax.faces.event.ActionEvent e)
void	dispose() Cleans up the resources used by this class.
void	folderSelected(javax.faces.event.ActionEvent e)
java.lang.String	getAny()
java.util.Date	getCreationDateFrom()
java.util.Date	getCreationDateTo()
DirectoryTreeModel	getDirectoryModel()
java.util.List<DocumentResult>	getDocumentResult()
int	getEstimatedHitsNumber()
java.lang.Long	getExcludeFromResult()
long	getExecTime()
java.lang.String[]	getExtendedAttributes()
int	getExtendedAttributesCount()
java.util.Collection<javax.faces.model.SelectItem>	getExtendedAttributesItems()
java.lang.String	getFormat()
int	getHitsPerBlock()
int	getHitsPerPage()
java.lang.String	getLanguage()
com.logicaldoc.core.searchengine.Search	getLastSearch()
java.lang.String	getNots()
java.lang.String	getParentPathDescr()
java.lang.Long	getParentPathId()
java.lang.String	getPhrase()
java.util.Date	getPublishingDateFrom()
java.util.Date	getPublishingDateTo()
java.lang.String	getQuery()
java.util.Map<java.lang.String,com.logicaldoc.core.searchengine.Hit>	getResultMap() Returns the results as a map, the key is docId.
java.lang.Long	getSizeMax()
java.lang.Long	getSizeMin()
java.util.Date	getSourceDateFrom()
java.util.Date	getSourceDateTo()
java.lang.Long	getTemplate()
javax.faces.component.UIInput	getUiPublishingDateFrom()
javax.faces.component.UIInput	getUiPublishingDateTo()
javax.faces.component.UIInput	getUiSizeMax()
javax.faces.component.UIInput	getUiSizeMin()
javax.faces.component.UIInput	getUiSourceDateFrom()
javax.faces.component.UIInput	getUiSourceDateTo()
java.lang.String	getViewMode()
boolean	isContent()
boolean	isCoverage()
boolean	isCustomId()
protected boolean	isDefaultAscending(java.lang.String columnName) Is the default sort direction for the given column "ascending" ?
boolean	isMoreHitsPresent()
boolean	isSearchInSubPath()
boolean	isSelectedAll()
boolean	isShowFolderSelector()
boolean	isSource()
boolean	isSourceAuthor()
boolean	isSourceType()
boolean	isTags()
boolean	isTitle()
void	onSelectViewMode(javax.faces.event.ValueChangeEvent vce)
void	openFolderSelector(javax.faces.event.ActionEvent e)
java.lang.String	quickSearch()
void	reset()
java.lang.String	search() Launches the search.
void	search(com.logicaldoc.core.searchengine.SearchOptions opt)
java.lang.String	searchHits() Execute the search.
java.lang.String	searchMore() Re-launches the search including one more block of hits.
java.lang.String	searchSimilar() Search for similar documents.
java.lang.String	selectAll()
void	setAny(java.lang.String any)
void	setContent(boolean content)
void	setCoverage(boolean coverage)
void	setCreationDateFrom(java.util.Date creationDateFrom)
void	setCreationDateTo(java.util.Date creationDateTo)
void	setCustomId(boolean customId)
void	setDocumentResult(java.util.List<DocumentResult> result)
void	setExcludeFromResult(java.lang.Long excludeFromResult)
void	setExtendedAttributes(java.lang.String[] extendedAttributes)
void	setExtendedAttributesItems(java.util.Collection<javax.faces.model.SelectItem> extendedAttributesItems)
void	setFormat(java.lang.String format)
void	setHitsPerPage(int hitsPerPage)
void	setLanguage(java.lang.String language)
void	setMenuBar(MenuBarBean menuBar)
void	setNots(java.lang.String not)
void	setParentPathDescr(java.lang.String parentPathDescr)
void	setParentPathId(java.lang.Long parentPathId)
void	setPhrase(java.lang.String phrase)
void	setPublishingDateFrom(java.util.Date publishingDateFrom)
void	setPublishingDateTo(java.util.Date publishingDateTo)
void	setQuery(java.lang.String query)
void	setSearchInSubPath(boolean searchInSubPath)
void	setSelectedAll(boolean selectedAll)
void	setShowFolderSelector(boolean showFolderSelector)
void	setSizeMax(java.lang.Long sizeMax)
void	setSizeMin(java.lang.Long sizeMin)
void	setSource(boolean source)
void	setSourceAuthor(boolean sourceAuthor)
void	setSourceDateFrom(java.util.Date sourceDateFrom)
void	setSourceDateTo(java.util.Date sourceDateTo)
void	setSourceType(boolean sourceType)
void	setTags(boolean tags)
void	setTemplate(java.lang.Long template)
void	setTitle(boolean title)
void	setUiPublishingDateFrom(javax.faces.component.UIInput uiPublishingDateFrom)
void	setUiPublishingDateTo(javax.faces.component.UIInput uiPublishingDateTo)
void	setUiSizeMax(javax.faces.component.UIInput uiSizeMax)
void	setUiSizeMin(javax.faces.component.UIInput uiSizeMin)
void	setUiSourceDateFrom(javax.faces.component.UIInput uiSourceDateFrom)
void	setUiSourceDateTo(javax.faces.component.UIInput uiSourceDateTo)
void	setViewMode(java.lang.String viewModeP)
java.lang.String	showDocumentPath() Search for similar documents.
java.lang.String	showLastSearch()
protected void	sort(java.lang.String column, boolean ascending) Sort the list.
java.lang.String	unselectAll()
void	validateCreationDates(javax.faces.context.FacesContext context, javax.faces.component.UIComponent component, java.lang.Object value)
void	validatePublishingDates(javax.faces.context.FacesContext context, javax.faces.component.UIComponent component, java.lang.Object value)
void	validateSizes(javax.faces.context.FacesContext context, javax.faces.component.UIComponent component, java.lang.Object value)
void	validateSourceDates(javax.faces.context.FacesContext context, javax.faces.component.UIComponent component, java.lang.Object value)

Methods inherited from class com.logicaldoc.web.components.SortableList

getSortColumn, isAscending, setAscending, setSortColumn, sort

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected static org.apache.commons.logging.Log logger

Constructor Detail

SearchForm

public SearchForm()

Method Detail

getTemplate

public java.lang.Long getTemplate()

setTemplate

public void setTemplate(java.lang.Long template)

getLanguage

public java.lang.String getLanguage()

getExtendedAttributes

public java.lang.String[] getExtendedAttributes()

setExtendedAttributes

public void setExtendedAttributes(java.lang.String[] extendedAttributes)

getAny

public java.lang.String getAny()

setAny

public void setAny(java.lang.String any)

isContent

public boolean isContent()

setContent

public void setContent(boolean content)

isCoverage

public boolean isCoverage()

isTitle

public boolean isTitle()

setCoverage

public void setCoverage(boolean coverage)

setTitle

public void setTitle(boolean title)

getFormat

public java.lang.String getFormat()

setFormat

public void setFormat(java.lang.String format)

isTags

public boolean isTags()

setTags

public void setTags(boolean tags)

getNots

public java.lang.String getNots()

setNots

public void setNots(java.lang.String not)

getPhrase

public java.lang.String getPhrase()

setPhrase

public void setPhrase(java.lang.String phrase)

getQuery

public java.lang.String getQuery()

setQuery

public void setQuery(java.lang.String query)

isSource

public boolean isSource()

setSource

public void setSource(boolean source)

isSourceAuthor

public boolean isSourceAuthor()

setSourceAuthor

public void setSourceAuthor(boolean sourceAuthor)

isSourceType

public boolean isSourceType()

setSourceType

public void setSourceType(boolean sourceType)

setLanguage

public void setLanguage(java.lang.String language)

setDocumentResult

public void setDocumentResult(java.util.List<DocumentResult> result)

getHitsPerPage

public int getHitsPerPage()

setHitsPerPage

public void setHitsPerPage(int hitsPerPage)

getDocumentResult

public java.util.List<DocumentResult> getDocumentResult()

validateSizes

public void validateSizes(javax.faces.context.FacesContext context,
                          javax.faces.component.UIComponent component,
                          java.lang.Object value)
                   throws javax.faces.validator.ValidatorException

Throws:

javax.faces.validator.ValidatorException

validateSourceDates

public void validateSourceDates(javax.faces.context.FacesContext context,
                                javax.faces.component.UIComponent component,
                                java.lang.Object value)
                         throws javax.faces.validator.ValidatorException

Throws:

javax.faces.validator.ValidatorException

validateCreationDates

public void validateCreationDates(javax.faces.context.FacesContext context,
                                  javax.faces.component.UIComponent component,
                                  java.lang.Object value)
                           throws javax.faces.validator.ValidatorException

Throws:

javax.faces.validator.ValidatorException

validatePublishingDates

public void validatePublishingDates(javax.faces.context.FacesContext context,
                                    javax.faces.component.UIComponent component,
                                    java.lang.Object value)
                             throws javax.faces.validator.ValidatorException

Throws:

javax.faces.validator.ValidatorException

getResultMap

public java.util.Map<java.lang.String,com.logicaldoc.core.searchengine.Hit> getResultMap()

Returns the results as a map, the key is docId.

Returns:

quickSearch

public java.lang.String quickSearch()

search

public java.lang.String search()

Launches the search.

showLastSearch

public java.lang.String showLastSearch()

searchHits

public java.lang.String searchHits()

Execute the search.

Note: only the first maxHits will be returned

search

public void search(com.logicaldoc.core.searchengine.SearchOptions opt)

isCustomId

public boolean isCustomId()

setCustomId

public void setCustomId(boolean customId)

searchMore

public java.lang.String searchMore()

Re-launches the search including one more block of hits.

searchSimilar

public java.lang.String searchSimilar()

Search for similar documents.

showDocumentPath

public java.lang.String showDocumentPath()

Search for similar documents.

dispose

public void dispose()

Cleans up the resources used by this class. This method could be called when a session destroyed event is called.

reset

public void reset()

advanced

public java.lang.String advanced()

Shows the advanced search form.

setMenuBar

public void setMenuBar(MenuBarBean menuBar)

isMoreHitsPresent

public boolean isMoreHitsPresent()

getHitsPerBlock

public int getHitsPerBlock()

getEstimatedHitsNumber

public int getEstimatedHitsNumber()

getExecTime

public long getExecTime()

getPublishingDateFrom

public java.util.Date getPublishingDateFrom()

setPublishingDateFrom

public void setPublishingDateFrom(java.util.Date publishingDateFrom)

getPublishingDateTo

public java.util.Date getPublishingDateTo()

getSizeMin

public java.lang.Long getSizeMin()

setSizeMin

public void setSizeMin(java.lang.Long sizeMin)

getSizeMax

public java.lang.Long getSizeMax()

setSizeMax

public void setSizeMax(java.lang.Long sizeMax)

getSourceDateFrom

public java.util.Date getSourceDateFrom()

setSourceDateFrom

public void setSourceDateFrom(java.util.Date sourceDateFrom)

getSourceDateTo

public java.util.Date getSourceDateTo()

setSourceDateTo

public void setSourceDateTo(java.util.Date sourceDateTo)

setPublishingDateTo

public void setPublishingDateTo(java.util.Date publishingDateTo)

getUiSizeMin

public javax.faces.component.UIInput getUiSizeMin()

setUiSizeMin

public void setUiSizeMin(javax.faces.component.UIInput uiSizeMin)

getUiSizeMax

public javax.faces.component.UIInput getUiSizeMax()

setUiSizeMax

public void setUiSizeMax(javax.faces.component.UIInput uiSizeMax)

getUiSourceDateFrom

public javax.faces.component.UIInput getUiSourceDateFrom()

setUiSourceDateFrom

public void setUiSourceDateFrom(javax.faces.component.UIInput uiSourceDateFrom)

getUiSourceDateTo

public javax.faces.component.UIInput getUiSourceDateTo()

setUiSourceDateTo

public void setUiSourceDateTo(javax.faces.component.UIInput uiSourceDateTo)

getUiPublishingDateFrom

public javax.faces.component.UIInput getUiPublishingDateFrom()

setUiPublishingDateFrom

public void setUiPublishingDateFrom(javax.faces.component.UIInput uiPublishingDateFrom)

getUiPublishingDateTo

public javax.faces.component.UIInput getUiPublishingDateTo()

setUiPublishingDateTo

public void setUiPublishingDateTo(javax.faces.component.UIInput uiPublishingDateTo)

openFolderSelector

public void openFolderSelector(javax.faces.event.ActionEvent e)

closeFolderSelector

public void closeFolderSelector(javax.faces.event.ActionEvent e)

cancelFolderSelector

public void cancelFolderSelector(javax.faces.event.ActionEvent e)

folderSelected

public void folderSelected(javax.faces.event.ActionEvent e)

getParentPathDescr

public java.lang.String getParentPathDescr()

setParentPathDescr

public void setParentPathDescr(java.lang.String parentPathDescr)

getExtendedAttributesItems

public java.util.Collection<javax.faces.model.SelectItem> getExtendedAttributesItems()

setExtendedAttributesItems

public void setExtendedAttributesItems(java.util.Collection<javax.faces.model.SelectItem> extendedAttributesItems)

isSearchInSubPath

public boolean isSearchInSubPath()

setSearchInSubPath

public void setSearchInSubPath(boolean searchInSubPath)

isShowFolderSelector

public boolean isShowFolderSelector()

setShowFolderSelector

public void setShowFolderSelector(boolean showFolderSelector)

getDirectoryModel

public DirectoryTreeModel getDirectoryModel()

getExcludeFromResult

public java.lang.Long getExcludeFromResult()

setExcludeFromResult

public void setExcludeFromResult(java.lang.Long excludeFromResult)

getExtendedAttributesCount

public int getExtendedAttributesCount()

changeTemplate

public void changeTemplate(javax.faces.event.ValueChangeEvent event)

getCreationDateFrom

public java.util.Date getCreationDateFrom()

setCreationDateFrom

public void setCreationDateFrom(java.util.Date creationDateFrom)

getCreationDateTo

public java.util.Date getCreationDateTo()

setCreationDateTo

public void setCreationDateTo(java.util.Date creationDateTo)

getViewMode

public java.lang.String getViewMode()

onSelectViewMode

public void onSelectViewMode(javax.faces.event.ValueChangeEvent vce)

setViewMode

public void setViewMode(java.lang.String viewModeP)

selectAll

public java.lang.String selectAll()

unselectAll

public java.lang.String unselectAll()

isDefaultAscending

protected boolean isDefaultAscending(java.lang.String columnName)

Description copied from class: SortableList

Is the default sort direction for the given column "ascending" ?

Specified by:

isDefaultAscending in class SortableList

sort

protected void sort(java.lang.String column,
                    boolean ascending)

Description copied from class: SortableList

Sort the list.

Specified by:

sort in class SortableList

isSelectedAll

public boolean isSelectedAll()

setSelectedAll

public void setSelectedAll(boolean selectedAll)

getLastSearch

public com.logicaldoc.core.searchengine.Search getLastSearch()

getParentPathId

public java.lang.Long getParentPathId()

setParentPathId

public void setParentPathId(java.lang.Long parentPathId)