javax.wvcm
Class SearchToken

java.lang.Object
  extended by javax.wvcm.SearchToken

public class SearchToken
extends java.lang.Object

NOT YET STANDARD Describes a search request.


Nested Class Summary
static class SearchToken.ContentExpression
          Represents a content-based expression
static class SearchToken.ContOperator
          Discrete values for content operators.
static class SearchToken.Depth
          Discrete values for parameter "depth".
static class SearchToken.Expression
          Represents an expression
static class SearchToken.LocationFilter
          Represents a filter on the last location segment
static class SearchToken.LogOperator
          Discrete values for logical operators.
static class SearchToken.NestedExpression
          Represents a nested AND or OR expression.
static class SearchToken.OrderDirection
          Discrete values for parameter "direction" (ascending, descending).
static class SearchToken.PropertyExpression
          Represents a property expression
static class SearchToken.PropOperator
          Discrete values for property operators.
static class SearchToken.SearchCondition
          Represents a search condition.
static class SearchToken.SortCriterion
          Represents a sorting criterion
static class SearchToken.XPathAttributeName
          XPath-based pseudo-attribute
 
Constructor Summary
SearchToken(SearchToken.SearchCondition condition)
          Constructor
SearchToken(SearchToken.SearchCondition condition, SearchToken.SortCriterion[] sortCriteria, SearchToken.Depth depth, java.lang.Integer limit)
          Constructor
 
Method Summary
 SearchToken.Depth depth()
          Get the search depth
 java.lang.Integer limit()
          Get the max. number of results to return
 SearchToken.SearchCondition searchCondition()
          Get the search condition
 SearchToken.SortCriterion[] sortCriteria()
          Get the sorting criteria
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SearchToken

public SearchToken(SearchToken.SearchCondition condition)
Constructor

Parameters:
condition - the search condition

SearchToken

public SearchToken(SearchToken.SearchCondition condition,
                   SearchToken.SortCriterion[] sortCriteria,
                   SearchToken.Depth depth,
                   java.lang.Integer limit)
Constructor

Parameters:
condition - the search condition
sortCriteria - the sorting criteria
depth - the search depth
limit - the max. number of results to return
Method Detail

searchCondition

public SearchToken.SearchCondition searchCondition()
Get the search condition

Returns:
a SearchCondition

sortCriteria

public SearchToken.SortCriterion[] sortCriteria()
Get the sorting criteria

Returns:
a SortCriterion[]

depth

public SearchToken.Depth depth()
Get the search depth

Returns:
an int

limit

public java.lang.Integer limit()
Get the max. number of results to return

Returns:
the limit


Copyright (c) 2003 - Apache Software Foundation