net.cnri.apps.dogui.controller

Class DOSearch

java.lang.Object

net.cnri.apps.dogui.controller.DOSearch

public class DOSearch
extends java.lang.Object

DOSearch represents a set of search terms that can include complete phrases, individual keywords, and attributed keywords such as att:author:dickens. A DOSearch can parse and format the search terms without losing the meaning of the search.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	DOSearch.SearchAttribute

Constructor Summary

Constructors

Constructor and Description
DOSearch() Initialize an empty search object
DOSearch(java.lang.String searchForm) Initialize a new search object using the given query

Method Summary

Methods

Modifier and Type	Method and Description
void	addAttribute(java.lang.String name)
void	addAttribute(java.lang.String name, java.lang.String value)
void	addKeyword(java.lang.String keyword)
void	addPhrase(java.lang.String phrase)
void	addRangeAttribute(java.lang.String name, java.util.Date minval, java.util.Date maxval) Set a date range attribute
void	addRangeAttribute(java.lang.String name, long minval, long maxval) Set a numeric range attribute
static java.lang.String	formatDate(java.util.Date dt) Format a java.util.Date object into a string representation suitable for date ranges in searches.
java.util.Iterator	getAttributes() Return an iterator of SearchAttribute objects
java.util.Date[]	getDateRange(java.lang.String attributeName) Return the date range value for an attribute.
java.lang.String	getFirstAttribute(java.lang.String name) Return the value of the first attribute, if any, that is associated with the given name
java.util.Iterator	getKeywords() Return an iterator of String objects representing keywords
long[]	getNumericRange(java.lang.String attributeName) Return the numeric range value for an attribute.
java.util.Iterator	getPhrases() Return an iterator of String objects representing phrases
static java.util.Date	parseDate(java.lang.String dtStr)
void	parseSearch(java.lang.String str) Replace the query parameters with the given query
java.lang.String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

DOSearch

public DOSearch()

Initialize an empty search object

DOSearch

public DOSearch(java.lang.String searchForm)

Initialize a new search object using the given query

Method Detail

addKeyword

public void addKeyword(java.lang.String keyword)

addPhrase

public void addPhrase(java.lang.String phrase)

addAttribute

public void addAttribute(java.lang.String name,
                java.lang.String value)

addAttribute

public void addAttribute(java.lang.String name)

getFirstAttribute

public java.lang.String getFirstAttribute(java.lang.String name)

Return the value of the first attribute, if any, that is associated with the given name

getNumericRange

public long[] getNumericRange(java.lang.String attributeName)

Return the numeric range value for an attribute. The numeric range will be represented as either null (if the attribute doesn't exist or is invalid) or a long array with length of two.

getDateRange

public java.util.Date[] getDateRange(java.lang.String attributeName)

Return the date range value for an attribute. The date range will be represented as either null (if the attribute doesn't exist or is invalid) or a Date array with length of two.

addRangeAttribute

public void addRangeAttribute(java.lang.String name,
                     long minval,
                     long maxval)

Set a numeric range attribute

addRangeAttribute

public void addRangeAttribute(java.lang.String name,
                     java.util.Date minval,
                     java.util.Date maxval)

Set a date range attribute

getAttributes

public java.util.Iterator getAttributes()

Return an iterator of SearchAttribute objects

getKeywords

public java.util.Iterator getKeywords()

Return an iterator of String objects representing keywords

getPhrases

public java.util.Iterator getPhrases()

Return an iterator of String objects representing phrases

parseSearch

public void parseSearch(java.lang.String str)

Replace the query parameters with the given query

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

formatDate

public static final java.lang.String formatDate(java.util.Date dt)

Format a java.util.Date object into a string representation suitable for date ranges in searches. The result will be formatted as yyyyMMddHHmmssSSS

parseDate

public static final java.util.Date parseDate(java.lang.String dtStr)