Criteria (Wikitty :: api 3.8 API)

java.lang.Object
- org.nuiton.wikitty.search.Criteria

All Implemented Interfaces:

Serializable, Cloneable

Deprecated.
since 3.3 use new query api WikittyQuery
```
@Deprecated
public class Criteria
extends Object
implements Serializable, Cloneable
```
Criteria represent the search on the wikitty with restriction on field and informations on facet, pagination and sorting.
For search multiple extension use ALL_EXTENSIONS as extension name and specify field type.
Example : Criteria.ALL_EXTENSIONS + Criteria.SEPARATOR + + Criteria.SEPARATOR + FieldType.TYPE.

Version:

$Revision: 1259 $ Last update: $Date: 2011-12-28 19:50:45 +0100 (mer. 28 déc. 2011) $ by : $Author: bpoussin $

Author:

poussin

See Also:
Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ALL_ELEMENTS` Deprecated. Use to not limit result.
`static String`	`ALL_EXTENSIONS` Deprecated. Search on all extension.
`static String`	`ALL_VALUES` Deprecated. Search on all values.
`protected int`	`endIndex` Deprecated. Last index to get result.
`protected List<Criteria>`	`facetCriteria` Deprecated. Facet on criteria.
`protected List<String>`	`facetField` Deprecated. Facet on field.
`protected int`	`facetLimit` Deprecated. Nombre maximum de facet a retourner apres la requete.
`protected int`	`facetMinCount` Deprecated. nombre minimum de valeur pour qu'une valeur apparaisse dans les facets.
`protected int`	`firstIndex` Deprecated. First index to get result.
`protected String`	`name` Deprecated. Criteria can have name this help for presentation and is very useful for facet created by criteria.
`protected Restriction`	`restriction` Deprecated. All restriction on fields.
`protected String`	`select` Deprecated. Use to return select ids Be carefull, can be long if many result is found
`static String`	`SEPARATOR` Deprecated. Separator between extension name, field name and type.
`protected List<String>`	`sortAscending` Deprecated. Sort ascending on fields.
`protected List<String>`	`sortDescending` Deprecated. Sort descending on fields.

Constructor Summary

Constructors
Constructor and Description

Criteria()
Deprecated.

Default constructor.

Criteria(String name)
Deprecated.

Create named criteria.

Constructors
Constructor and Description
`Criteria()` Deprecated. Default constructor.
`Criteria(String name)` Deprecated. Create named criteria.

Method Summary

Methods
Modifier and Type	Method and Description
`Criteria`	`addFacetCriteria(Criteria criteria)` Deprecated.
`Criteria`	`addFacetField(String field)` Deprecated.
`Criteria`	`addSortAscending(String... field)` Deprecated.
`Criteria`	`addSortDescending(String... field)` Deprecated.
`Criteria`	`clone()` Deprecated. Cree un nouvel objet criteria ou l'objet restriction est pointer par les deux critere apres le clone.
`static Criteria`	`fromXML(String xml)` Deprecated. Deserialize xml to criteria.
`int`	`getEndIndex()` Deprecated.
`List<Criteria>`	`getFacetCriteria()` Deprecated.
`List<String>`	`getFacetField()` Deprecated.
`int`	`getFacetLimit()` Deprecated.
`int`	`getFacetMinCount()` Deprecated.
`int`	`getFirstIndex()` Deprecated.
`String`	`getName()` Deprecated.
`Restriction`	`getRestriction()` Deprecated.
`String`	`getSelect()` Deprecated.
`List<String>`	`getSortAscending()` Deprecated. Get field names where sort is configured ascending.
`List<String>`	`getSortDescending()` Deprecated. Get field names where sort is configured descending.
`Criteria`	`setEndIndex(int endIndex)` Deprecated.
`Criteria`	`setFacetCriteria(Criteria[] facetCriteria)` Deprecated.
`Criteria`	`setFacetField(String[] facetField)` Deprecated.
`Criteria`	`setFacetLimit(int facetLimit)` Deprecated.
`Criteria`	`setFacetMinCount(int facetMinCount)` Deprecated.
`Criteria`	`setFirstIndex(int firstIndex)` Deprecated.
`void`	`setName(String name)` Deprecated.
`void`	`setRestriction(Restriction restriction)` Deprecated.
`void`	`setRestriction(Search search)` Deprecated. Substitue la restriction de ce critere par celui de search
`void`	`setSelect(String select)` Deprecated.
`Criteria`	`setSortAscending(String... sortAscending)` Deprecated.
`Criteria`	`setSortDescending(String... sortDescending)` Deprecated.
`String`	`toString()` Deprecated.
`static String`	`toXML(Criteria criteria)` Deprecated. Serialize criteria to xml.

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

- Field Detail
  - ALL_ELEMENTS
```
public static final int ALL_ELEMENTS
```
    Deprecated.
    
    Use to not limit result.
    
    See Also:
    Constant Field Values
  - ALL_EXTENSIONS
```
public static final String ALL_EXTENSIONS
```
    Deprecated.
    
    Search on all extension.
    
    See Also:
    Constant Field Values
  - ALL_VALUES
```
public static final String ALL_VALUES
```
    Deprecated.
    
    Search on all values.
    
    See Also:
    Constant Field Values
  - SEPARATOR
```
public static final String SEPARATOR
```
    Deprecated.
    
    Separator between extension name, field name and type.
    
    See Also:
    Constant Field Values
  - name
```
protected String name
```
    Deprecated.
    
    Criteria can have name this help for presentation and is very useful for facet created by criteria.
  - select
```
protected String select
```
    Deprecated.
    
    Use to return select ids Be carefull, can be long if many result is found
  - restriction
```
protected Restriction restriction
```
    Deprecated.
    
    All restriction on fields.
  - firstIndex
```
protected int firstIndex
```
    Deprecated.
    
    First index to get result.
  - endIndex
```
protected int endIndex
```
    Deprecated.
    
    Last index to get result.
  - facetMinCount
```
protected int facetMinCount
```
    Deprecated.
    
    nombre minimum de valeur pour qu'une valeur apparaisse dans les facets. par defaut, il doit y avoir plus que 1 valeur.
  - facetLimit
```
protected int facetLimit
```
    Deprecated.
    
    Nombre maximum de facet a retourner apres la requete. Par default on en retourne 100.
  - facetCriteria
```
protected List<Criteria> facetCriteria
```
    Deprecated.
    
    Facet on criteria.
  - facetField
```
protected List<String> facetField
```
    Deprecated.
    
    Facet on field.
  - sortAscending
```
protected List<String> sortAscending
```
    Deprecated.
    
    Sort ascending on fields.
  - sortDescending
```
protected List<String> sortDescending
```
    Deprecated.
    
    Sort descending on fields.
- Constructor Detail
  - Criteria
```
public Criteria()
```
    Deprecated.
    
    Default constructor.
  - Criteria
```
public Criteria(String name)
```
    Deprecated.
    
    Create named criteria.
    
    Parameters:
    name - criteria name
- Method Detail
  - clone
```
public Criteria clone()
```
    Deprecated.
    
    Cree un nouvel objet criteria ou l'objet restriction est pointer par les deux critere apres le clone. La modification d'une restriction impactera l'autre critere. (Ce comportement peut-etre modifier si besoin). Tous les autres champs sont en deepcopy.
    
    Overrides:
    
    clone in class Object
    
    Returns:
    
    Throws:
    
    WikittyException
  - fromXML
```
public static Criteria fromXML(String xml)
```
    Deprecated.
    
    Deserialize xml to criteria.
    
    Parameters:
    xml - xml to deserialize
    
    Returns:
    criteria criteria
  - toXML
```
public static String toXML(Criteria criteria)
```
    Deprecated.
    
    Serialize criteria to xml.
    
    Parameters:
    criteria - criteria to serialize
    
    Returns:
    xml string
  - getRestriction
```
public Restriction getRestriction()
```
    Deprecated.
  - setRestriction
```
public void setRestriction(Restriction restriction)
```
    Deprecated.
  - setRestriction
```
public void setRestriction(Search search)
```
    Deprecated.
    
    Substitue la restriction de ce critere par celui de search
    
    Parameters:
    search -
  - getName
```
public String getName()
```
    Deprecated.
  - setName
```
public void setName(String name)
```
    Deprecated.
  - getSelect
```
public String getSelect()
```
    Deprecated.
  - setSelect
```
public void setSelect(String select)
```
    Deprecated.
  - getFirstIndex
```
public int getFirstIndex()
```
    Deprecated.
  - setFirstIndex
```
public Criteria setFirstIndex(int firstIndex)
```
    Deprecated.
  - getEndIndex
```
public int getEndIndex()
```
    Deprecated.
  - setEndIndex
```
public Criteria setEndIndex(int endIndex)
```
    Deprecated.
  - getFacetMinCount
```
public int getFacetMinCount()
```
    Deprecated.
  - setFacetMinCount
```
public Criteria setFacetMinCount(int facetMinCount)
```
    Deprecated.
  - getFacetLimit
```
public int getFacetLimit()
```
    Deprecated.
  - setFacetLimit
```
public Criteria setFacetLimit(int facetLimit)
```
    Deprecated.
  - getFacetCriteria
```
public List<Criteria> getFacetCriteria()
```
    Deprecated.
  - addFacetCriteria
```
public Criteria addFacetCriteria(Criteria criteria)
```
    Deprecated.
  - setFacetCriteria
```
public Criteria setFacetCriteria(Criteria[] facetCriteria)
```
    Deprecated.
  - getFacetField
```
public List<String> getFacetField()
```
    Deprecated.
  - addFacetField
```
public Criteria addFacetField(String field)
```
    Deprecated.
  - setFacetField
```
public Criteria setFacetField(String[] facetField)
```
    Deprecated.
  - getSortAscending
```
public List<String> getSortAscending()
```
    Deprecated.
    
    Get field names where sort is configured ascending.
    
    Returns:
    field names
  - addSortAscending
```
public Criteria addSortAscending(String... field)
```
    Deprecated.
  - setSortAscending
```
public Criteria setSortAscending(String... sortAscending)
```
    Deprecated.
  - getSortDescending
```
public List<String> getSortDescending()
```
    Deprecated.
    
    Get field names where sort is configured descending.
    
    Returns:
    field names
  - addSortDescending
```
public Criteria addSortDescending(String... field)
```
    Deprecated.
  - setSortDescending
```
public Criteria setSortDescending(String... sortDescending)
```
    Deprecated.
  - toString
```
public String toString()
```
    Deprecated.
    
    Overrides:
    
    toString in class Object

Class Criteria

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ALL_ELEMENTS

ALL_EXTENSIONS

ALL_VALUES

SEPARATOR

name

select

restriction

firstIndex

endIndex

facetMinCount

facetLimit

facetCriteria

facetField

sortAscending

sortDescending

Constructor Detail

Criteria

Criteria

Method Detail

clone

fromXML

toXML

getRestriction

setRestriction

setRestriction

getName

setName

getSelect

setSelect

getFirstIndex

setFirstIndex

getEndIndex

setEndIndex

getFacetMinCount

setFacetMinCount

getFacetLimit

setFacetLimit

getFacetCriteria

addFacetCriteria

setFacetCriteria

getFacetField

addFacetField

setFacetField

getSortAscending

addSortAscending

setSortAscending

getSortDescending

addSortDescending

setSortDescending

toString