com.webmethods.caf.faces.data.csp
Class CSPIndex

java.lang.Object
  com.webmethods.caf.faces.data.csp.CSPIndex

All Implemented Interfaces:

Serializable

public final class CSPIndex
extends Object
implements Serializable

CSPIndex represents a metadata for a CSPContent CSPContent can have multiple sets of indexes and within each set of indexes ,an index may have multiple values CSPIndex.getValues().

See Also:

Serialized Form

Constructor Summary

CSPIndex()

Method Summary

void	addParameter(CSPParameter parameter)
static CSPIndex	create(String name, String id)
static CSPIndex	create(String name, String id, String description)
static CSPIndex	create(String name, String type, String id, String description)
String	getDescription()
String	getId()
Locale	getLocale()
String	getName()
String	getParameter(String name) Returns the value of the specified parameter name
List	getParameters() Returns list containing the parameters of this index.
String	getType()
String	getValue() Called when the index has single value.
String[]	getValues() Called when an index has multiple values.
void	setDescription(String fDescription)
void	setId(String fId)
void	setLocale(Locale locale)
void	setName(String fName)
void	setParameters(List parameters) Sets the argument as parameter of this index and clears the previous parameters if any
void	setType(String type)
void	setValue(String fValue)
void	setValues(String[] values)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

CSPIndex

public CSPIndex()

Method Detail

getLocale

public Locale getLocale()

setLocale

public void setLocale(Locale locale)

setName

public void setName(String fName)

getName

public String getName()

setId

public void setId(String fId)

getId

public String getId()

getDescription

public String getDescription()

setDescription

public void setDescription(String fDescription)

setValue

public void setValue(String fValue)

getValue

public String getValue()

Called when the index has single value. If the index is multi-valued returns null

Returns:

value. If the index is multi-valued returns null

setValues

public void setValues(String[] values)

getValues

public String[] getValues()

Called when an index has multiple values. If the index is single-valued returns null

Returns:

Collection of index values. If the index is single-valued returns null

setType

public void setType(String type)

getType

public String getType()

getParameters

public List getParameters()

Returns list containing the parameters of this index. Use with caution because every call creates a new list object.

Returns:

List containing the parameters of this index

setParameters

public void setParameters(List parameters)

Sets the argument as parameter of this index and clears the previous parameters if any

Parameters:

parameters - The new parameters for this index

getParameter

public String getParameter(String name)

Returns the value of the specified parameter name

Parameters:

name - Parameter's name

Returns:

Value of the specified parameter name

addParameter

public void addParameter(CSPParameter parameter)

create

public static CSPIndex create(String name,
                              String id)

create

public static CSPIndex create(String name,
                              String id,
                              String description)

create

public static CSPIndex create(String name,
                              String type,
                              String id,
                              String description)

Parameters:

name - The name of the index

type - - it might be string or integer

id -

description -

Returns:

toString

public String toString()

Overrides:

toString in class Object