org.eclipse.soda.dk.epcglobal.llrp.config.servlet.display
Class ParameterDisplay

java.lang.Object
  org.eclipse.soda.dk.epcglobal.llrp.config.servlet.display.AbstractDisplayElement
      org.eclipse.soda.dk.epcglobal.llrp.config.servlet.display.ParameterDisplay

All Implemented Interfaces:

IDisplayElement

Direct Known Subclasses:

ProfileDisplay

public class ParameterDisplay
extends AbstractDisplayElement

Since:

1.2

Version:

1.2.0

Field Summary

static char	CHOICE_SEPERATOR Define the choice seperator (char) constant.
static char	SEPERATOR Define the seperator (char) constant.

Fields inherited from interface org.eclipse.soda.dk.epcglobal.llrp.config.servlet.display.IDisplayElement

TYPE_PARAMETER, TYPE_PROFILE, TYPE_READER

Constructor Summary

ParameterDisplay(java.lang.String name, java.lang.Object paramObj)
Constructs an instance of this class from the specified name and param obj parameters.

ParameterDisplay(java.lang.String name, java.lang.Object paramObj, int type, java.util.List historyChain, IReaderCapabilities readerCapabilities)
Constructs an instance of this class from the specified name, param obj, type, history chain and reader capabilities parameters.

ParameterDisplay(java.lang.String name, java.lang.Object paramObj, java.util.List historyChain)
Constructs an instance of this class from the specified name, param obj and history chain parameters.

ParameterDisplay(java.lang.String name, java.lang.Object paramObj, java.util.List historyChain, IReaderCapabilities readerCapabilities)
Constructs an instance of this class from the specified name, param obj, history chain and reader capabilities parameters.

Method Summary

static java.lang.String	addSerialNumToPath(java.lang.String path, int serialNum) Add serial num to path with the specified path and serial num parameters and return the String result.
static java.lang.String	getChoiceId(java.lang.String choiceParamPath) Get choice id with the specified choice param path parameter and return the String result.
static java.lang.String	getChoiceParamId(java.lang.String choiceParamPath) Get choice param id with the specified choice param path parameter and return the String result.
static java.lang.String	getElementPath(java.lang.String elementId) Get element path with the specified element id parameter and return the String result.
static java.lang.String	getElementPath(java.lang.String choiceId, java.lang.String elementId) Get element path with the specified choice id and element id parameters and return the String result.
protected java.lang.String	getFormHeader(java.lang.String servletPath) Get form header with the specified servlet path parameter and return the String result.
protected java.lang.String	getFormTail(boolean subParamOnly) Get form tail with the specified sub param only parameter and return the String result.
java.util.List	getHistoryChain() Gets the history chain (List) value.
java.lang.String	getHtml(java.lang.String servletPath) Get html with the specified servlet path parameter and return the String result.
protected java.lang.String	getNavigatorHtml(java.lang.String servletPath) Get navigator html with the specified servlet path parameter and return the String result.
java.lang.String	getParamId() Gets the param ID (String) value.
static java.lang.String	getParamId(java.lang.String name) Get param id with the specified name parameter and return the String result.
IReaderCapabilities	getReaderCapabilities() Gets the reader capabilities (IReaderCapabilities) value.
int	getSerialNo() Gets the serial no (int) value.
static int	getSerialNo(java.lang.String name) Get serial no with the specified name parameter and return the int result.
static boolean	isChoiceParamPath(java.lang.String path) Is choice param path with the specified path parameter and return the boolean result.
boolean	isValidSubparameters() Gets the valid sub parameters (boolean) value.
protected boolean	isValidSubparameters(java.lang.String paramId, java.util.Map paramObj) Is valid sub parameters with the specified param id and param obj parameters and return the boolean result.
boolean	setParamValues(javax.servlet.http.HttpServletRequest request) Sets the param values value.

Methods inherited from class org.eclipse.soda.dk.epcglobal.llrp.config.servlet.display.AbstractDisplayElement

addComment, addCommentTitle, clearComment, getButton, getComment, getJavaScriptFunction, getName, getParamObj, getType, setName

Methods inherited from class java.lang.Object

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

Field Detail

SEPERATOR

public static final char SEPERATOR

Define the seperator (char) constant.

See Also:

Constant Field Values

CHOICE_SEPERATOR

public static final char CHOICE_SEPERATOR

Define the choice seperator (char) constant.

See Also:

Constant Field Values

Constructor Detail

ParameterDisplay

public ParameterDisplay(java.lang.String name,
                        java.lang.Object paramObj)

Constructs an instance of this class from the specified name and param obj parameters.

Parameters:

name - The name (String) parameter.

paramObj - The param obj (Object) parameter.

See Also:

ParameterDisplay(String,Object,int,List,IReaderCapabilities), ParameterDisplay(String,Object,List), ParameterDisplay(String,Object,List,IReaderCapabilities)

ParameterDisplay

public ParameterDisplay(java.lang.String name,
                        java.lang.Object paramObj,
                        int type,
                        java.util.List historyChain,
                        IReaderCapabilities readerCapabilities)

Constructs an instance of this class from the specified name, param obj, type, history chain and reader capabilities parameters.

Parameters:

name - The name (String) parameter.

paramObj - The param obj (Object) parameter.

type - The type (int) parameter.

historyChain - The history chain (List) parameter.

readerCapabilities - The reader capabilities (IReaderCapabilities) parameter.

See Also:

ParameterDisplay(String,Object), ParameterDisplay(String,Object,List), ParameterDisplay(String,Object,List,IReaderCapabilities)

ParameterDisplay

public ParameterDisplay(java.lang.String name,
                        java.lang.Object paramObj,
                        java.util.List historyChain)

Constructs an instance of this class from the specified name, param obj and history chain parameters.

Parameters:

name - The name (String) parameter.

paramObj - The param obj (Object) parameter.

historyChain - The history chain (List) parameter.

See Also:

ParameterDisplay(String,Object), ParameterDisplay(String,Object,int,List,IReaderCapabilities), ParameterDisplay(String,Object,List,IReaderCapabilities)

ParameterDisplay

public ParameterDisplay(java.lang.String name,
                        java.lang.Object paramObj,
                        java.util.List historyChain,
                        IReaderCapabilities readerCapabilities)

Constructs an instance of this class from the specified name, param obj, history chain and reader capabilities parameters.

Parameters:

name - The name (String) parameter.

paramObj - The param obj (Object) parameter.

historyChain - The history chain (List) parameter.

readerCapabilities - The reader capabilities (IReaderCapabilities) parameter.

See Also:

ParameterDisplay(String,Object), ParameterDisplay(String,Object,int,List,IReaderCapabilities), ParameterDisplay(String,Object,List)

Method Detail

addSerialNumToPath

public static java.lang.String addSerialNumToPath(java.lang.String path,
                                                  int serialNum)

Add serial num to path with the specified path and serial num parameters and return the String result.

Parameters:

path - The path (String) parameter.

serialNum - The serial num (int) parameter.

Returns:

Results of the add serial num to path (String) value.

getChoiceId

public static java.lang.String getChoiceId(java.lang.String choiceParamPath)

Get choice id with the specified choice param path parameter and return the String result.

Parameters:

choiceParamPath - The choice param path (String) parameter.

Returns:

Results of the get choice id (String) value.

getChoiceParamId

public static java.lang.String getChoiceParamId(java.lang.String choiceParamPath)

Get choice param id with the specified choice param path parameter and return the String result.

Parameters:

choiceParamPath - The choice param path (String) parameter.

Returns:

Results of the get choice param id (String) value.

getElementPath

public static java.lang.String getElementPath(java.lang.String elementId)

Get element path with the specified element id parameter and return the String result.

Parameters:

elementId - The element ID (String) parameter.

Returns:

Results of the get element path (String) value.

See Also:

getElementPath(String,String)

getElementPath

public static java.lang.String getElementPath(java.lang.String choiceId,
                                              java.lang.String elementId)

Get element path with the specified choice id and element id parameters and return the String result.

Parameters:

choiceId - The choice ID (String) parameter.

elementId - The element ID (String) parameter.

Returns:

Results of the get element path (String) value.

See Also:

getElementPath(String)

getParamId

public static java.lang.String getParamId(java.lang.String name)

Get param id with the specified name parameter and return the String result.

Parameters:

name - The name (String) parameter.

Returns:

Results of the get param id (String) value.

See Also:

getChoiceParamId(String), getParamId()

getSerialNo

public static int getSerialNo(java.lang.String name)

Get serial no with the specified name parameter and return the int result.

Parameters:

name - The name (String) parameter.

Returns:

Results of the get serial no (int) value.

See Also:

getSerialNo()

isChoiceParamPath

public static boolean isChoiceParamPath(java.lang.String path)

Is choice param path with the specified path parameter and return the boolean result.

Parameters:

path - The path (String) parameter.

Returns:

Results of the is choice param path (boolean) value.

getFormHeader

protected java.lang.String getFormHeader(java.lang.String servletPath)

Get form header with the specified servlet path parameter and return the String result.

Parameters:

servletPath - The servlet path (String) parameter.

Returns:

Results of the get form header (String) value.

getFormTail

protected java.lang.String getFormTail(boolean subParamOnly)

Get form tail with the specified sub param only parameter and return the String result.

Parameters:

subParamOnly - The sub param only (boolean) parameter.

Returns:

The form tail (String) value.

getHistoryChain

public java.util.List getHistoryChain()

Gets the history chain (List) value.

Returns:

The history chain (List) value.

getHtml

public java.lang.String getHtml(java.lang.String servletPath)

Get html with the specified servlet path parameter and return the String result.

Parameters:

servletPath - The servlet path (String) parameter.

Returns:

Results of the get html (String) value.

See Also:

getNavigatorHtml(String)

getNavigatorHtml

protected java.lang.String getNavigatorHtml(java.lang.String servletPath)

Get navigator html with the specified servlet path parameter and return the String result.

Parameters:

servletPath - The servlet path (String) parameter.

Returns:

Results of the get navigator html (String) value.

getParamId

public java.lang.String getParamId()

Gets the param ID (String) value.

Returns:

The param id (String) value.

See Also:

getChoiceParamId(String), getParamId(String)

getReaderCapabilities

public IReaderCapabilities getReaderCapabilities()

Gets the reader capabilities (IReaderCapabilities) value.

Returns:

The reader capabilities (IReaderCapabilities) value.

getSerialNo

public int getSerialNo()

Gets the serial no (int) value.

Returns:

The serial no (int) value.

See Also:

getSerialNo(String)

isValidSubparameters

public boolean isValidSubparameters()

Gets the valid sub parameters (boolean) value.

Returns:

The valid sub parameters (boolean) value.

See Also:

isValidSubparameters(String,Map)

isValidSubparameters

protected boolean isValidSubparameters(java.lang.String paramId,
                                       java.util.Map paramObj)

Is valid sub parameters with the specified param id and param obj parameters and return the boolean result.

Parameters:

paramId - The param ID (String) parameter.

paramObj - The param obj (Map) parameter.

Returns:

Results of the is valid sub parameters (boolean) value.

See Also:

isValidSubparameters()

setParamValues

public boolean setParamValues(javax.servlet.http.HttpServletRequest request)

Sets the param values value.

Parameters:

request - The request (HttpServletRequest) parameter.

Returns:

The param values (boolean) value.