AxisValueCriterion (Silverpeas Core 6.3 API)

java.lang.Object
- org.silverpeas.core.pdc.classification.Criteria
- - org.silverpeas.core.pdc.pdc.model.SearchCriteria
  - - org.silverpeas.core.pdc.pdc.model.AxisValueCriterion

All Implemented Interfaces:

Serializable, Cloneable
```
public class AxisValueCriterion
extends SearchCriteria
```
A criterion on the axis' value to take into account in a search, selection or any process that supports filtering.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor Description

AxisValueCriterion(String axisId, String valuePath)
Constructs a new criterion on the specified axis' value

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static List<AxisValueCriterion>`	`fromFlattenedAxisValues(String flattenAxisValues)`	Converts the axis' values encoded into the specified string into a list of criterion on an axis' value.
`String`	`getValuePath()`	Gets the path of the axis' value from the root axis' value.

Methods inherited from class org.silverpeas.core.pdc.pdc.model.SearchCriteria
clone, equals, hashCode, toString

Methods inherited from class org.silverpeas.core.pdc.classification.Criteria
checkCriteria, getAxisId, getValue, setAxisId, setValue

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

- Constructor Detail
  - AxisValueCriterion
```
public AxisValueCriterion(String axisId,
                          String valuePath)
```
    Constructs a new criterion on the specified axis' value
    
    Parameters:
    
    axisId - the unique identifier of the axis.
    
    valuePath - the path of the value of the axis above from the root axis value.
- Method Detail
  - fromFlattenedAxisValues
```
public static List<AxisValueCriterion> fromFlattenedAxisValues(String flattenAxisValues)
```
    Converts the axis' values encoded into the specified string into a list of criterion on an axis' value.
    
    Parameters:
    
    flattenAxisValues - the string of comma-separated axis' values. Each value is represented by the token 'axis id':'value id' where the identifier of the value is its path from the root value of the axis it belongs to.
    
    Returns:
    
    a list of AxisValueCriterion instances for each value encoded into the string.
  - getValuePath
```
public String getValuePath()
```
    Gets the path of the axis' value from the root axis' value.
    
    Returns:
    
    the value path.