net.windward.xmlreport

Class TemplateVariable

java.lang.Object

net.windward.xmlreport.TemplateVariable

public class TemplateVariable
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TemplateVariable.CAL_OFFSET What offset from the date run to set the calendar value to.
static class	TemplateVariable.VAR_TYPE What type of variable this data is

Constructor Summary

Constructors

Constructor and Description
TemplateVariable(java.lang.String name, java.lang.String udtGuid, boolean required, boolean allowAll, boolean allowList, boolean allowFilter, boolean allowSort, TemplateVariable.VAR_TYPE varType, java.lang.Iterable<TemplateVariableValue> defaultValues, java.lang.Iterable<TemplateVariableValue> allowedValues, java.lang.String description, java.lang.String datasource) Create a SELECT object.
TemplateVariable(java.lang.String name, java.lang.String udtGuid, boolean required, boolean allowAll, boolean allowList, boolean allowFilter, boolean allowSort, TemplateVariable.VAR_TYPE varType, java.lang.Object defValue, java.lang.String description, java.lang.String datasource) Create a SELECT object.
TemplateVariable(java.lang.String name, java.lang.String udtGuid, boolean required, TemplateVariable.VAR_TYPE varType, java.lang.Iterable<TemplateVariableValue> defaultValues, java.lang.Iterable<TemplateVariableValue> allowedValues, TemplateVariable.CAL_OFFSET calOffset, java.lang.String description) Create a non-SELECT object.
TemplateVariable(java.lang.String name, java.lang.String udtGuid, boolean required, TemplateVariable.VAR_TYPE varType, java.lang.Object defValue, TemplateVariable.CAL_OFFSET calOffset, java.lang.String description) Create a non-SELECT object.
TemplateVariable(java.lang.String name, TemplateVariable src) Create a variable object with a new name.
TemplateVariable(TemplateVariable src) Copy constructor.

Method Summary

Modifier and Type	Method and Description
static java.util.ArrayList<TemplateVariable>	FromXml(TinyElement xml) Deprecated. For Windward use only.
java.util.List<TemplateVariableValue>	getAllowedValues() The allowed values for this var.
java.lang.String	getAutoMetadata() If this is an auto-select, this is the metadata for the select.
TemplateVariable.CAL_OFFSET	getCalOffset() The date default value can be set to a calendar offset.
java.lang.String	getDataSource() The name of the datasource for the select.
java.util.List<TemplateVariableValue>	getDefaultValues() The default values for this var.
java.lang.String	getDescription() The description of this variable.
java.lang.String	getName() The name of the variable.
java.lang.String	getUdtGuid() If this is from a UDT it optionally has the GUID of the UDT item.
TemplateVariable.VAR_TYPE	getVarType() What type of data this variable is.
boolean	isAllowAll() Can return all values for this select variable.
boolean	isAllowFilter() Can set a filter for values for this select variable.
boolean	isAllowList() Can return a list of values for this select variable.
boolean	isAllowSort() Can sort values for this select variable.
boolean	isRequired() true if this variable must be set.
void	setAutoMetadata(java.lang.String value) If this is an auto-select, this is the metadata for the select.
static TemplateVariable	SingleFromXml(TinyElement xml) Deprecated. For Windward use only.

Methods inherited from class java.lang.Object

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

Constructor Detail

TemplateVariable

public TemplateVariable(java.lang.String name,
                        java.lang.String udtGuid,
                        boolean required,
                        TemplateVariable.VAR_TYPE varType,
                        java.lang.Object defValue,
                        TemplateVariable.CAL_OFFSET calOffset,
                        java.lang.String description)

Create a non-SELECT object.

Parameters:

name - The name of the variable.

udtGuid - The guid (can be null) for this if a UDT.

required - true if this variable must be set.

varType - What type of data this variable is.

defValue - The default value for this var. Can be null.

calOffset - For a default date, the calendar offset.

description - The description of this variable. This is optional.

TemplateVariable

public TemplateVariable(java.lang.String name,
                        java.lang.String udtGuid,
                        boolean required,
                        boolean allowAll,
                        boolean allowList,
                        boolean allowFilter,
                        boolean allowSort,
                        TemplateVariable.VAR_TYPE varType,
                        java.lang.Object defValue,
                        java.lang.String description,
                        java.lang.String datasource)

Create a SELECT object.

Parameters:

name - The name of the variable.

udtGuid - The guid (can be null) for this if a UDT.

required - true if this variable must be set.

allowAll - Can return all values for this select variable.

allowList - Can return a list of values for this select variable.

allowFilter - Can return a filtered result for this select variable.

allowSort - Can return a sorted result for this select variable.

varType - What type of data this variable is. This should be SELECT.

defValue - The default value for this var. Can be null.

description - The description of this variable. This is optional.

datasource - The name of the datasource for the select.

TemplateVariable

public TemplateVariable(java.lang.String name,
                        java.lang.String udtGuid,
                        boolean required,
                        TemplateVariable.VAR_TYPE varType,
                        java.lang.Iterable<TemplateVariableValue> defaultValues,
                        java.lang.Iterable<TemplateVariableValue> allowedValues,
                        TemplateVariable.CAL_OFFSET calOffset,
                        java.lang.String description)

Create a non-SELECT object.

Parameters:

name - The name of the variable.

udtGuid - The guid (can be null) for this if a UDT.

required - true if this variable must be set.

varType - What type of data this variable is.

defaultValues - The default value for this var. Can be [0].

allowedValues - The default value for this var. Can be [0].

calOffset - For a default date, the calendar offset.

description - The description of this variable. This is optional.

TemplateVariable

public TemplateVariable(java.lang.String name,
                        java.lang.String udtGuid,
                        boolean required,
                        boolean allowAll,
                        boolean allowList,
                        boolean allowFilter,
                        boolean allowSort,
                        TemplateVariable.VAR_TYPE varType,
                        java.lang.Iterable<TemplateVariableValue> defaultValues,
                        java.lang.Iterable<TemplateVariableValue> allowedValues,
                        java.lang.String description,
                        java.lang.String datasource)

Create a SELECT object.

Parameters:

name - The name of the variable.

udtGuid - The guid (can be null) for this if a UDT.

required - true if this variable must be set.

allowAll - Can return all values for this select variable.

allowList - Can return a list of values for this select variable.

allowFilter - Can return a filtered result for this select variable.

allowSort - Can return a sorted result for this select variable.

varType - What type of data this variable is. This should be SELECT.

defaultValues - The default value for this var. Can be [0].

allowedValues - The default value for this var. Can be [0].

description - The description of this variable. This is optional.

datasource - The name of the datasource for the select.

TemplateVariable

public TemplateVariable(java.lang.String name,
                        TemplateVariable src)

Create a variable object with a new name.

Parameters:

name - The new name.

src - Everything else is copied from this.

TemplateVariable

public TemplateVariable(TemplateVariable src)

Copy constructor. Copies ActiveValue and ActiveSort but no other Active* members.

Parameters:

src - The source object to copy from.

Method Detail

FromXml

public static java.util.ArrayList<TemplateVariable> FromXml(TinyElement xml)
                                                     throws java.lang.Exception

Deprecated. For Windward use only.

Create a list of TemplateVariables from the template metadata XML.

Parameters:

xml - The xml of the variables.

Returns:

The variables deserialized into this object.

Throws:

java.lang.Exception

SingleFromXml

public static TemplateVariable SingleFromXml(TinyElement xml)
                                      throws java.lang.Exception

Deprecated. For Windward use only.

Create a TemplateVariable from the template metadata XML.

Parameters:

xml - The xml of the variables.

Returns:

The variable deserialized into this object.

Throws:

java.lang.Exception

getName

public java.lang.String getName()

The name of the variable.

getUdtGuid

public java.lang.String getUdtGuid()

If this is from a UDT it optionally has the GUID of the UDT item.

isRequired

public boolean isRequired()

true if this variable must be set.

isAllowAll

public boolean isAllowAll()

Can return all values for this select variable.

isAllowList

public boolean isAllowList()

Can return a list of values for this select variable.

isAllowFilter

public boolean isAllowFilter()

Can set a filter for values for this select variable.

isAllowSort

public boolean isAllowSort()

Can sort values for this select variable.

getVarType

public TemplateVariable.VAR_TYPE getVarType()

What type of data this variable is.

getCalOffset

public TemplateVariable.CAL_OFFSET getCalOffset()

The date default value can be set to a calendar offset.

getDataSource

public java.lang.String getDataSource()

The name of the datasource for the select.

getDescription

public java.lang.String getDescription()

The description of this variable. This is optional.

getAutoMetadata

public java.lang.String getAutoMetadata()

If this is an auto-select, this is the metadata for the select. For SQL this is [dbo.]table.column using the raw values (no surrounding spaces) and for XML it is the full XPath to that node.

setAutoMetadata

public void setAutoMetadata(java.lang.String value)

If this is an auto-select, this is the metadata for the select. For SQL this is [dbo.]table.column using the raw values (no surrounding spaces) and for XML it is the full XPath to that node.

getDefaultValues

public java.util.List<TemplateVariableValue> getDefaultValues()

The default values for this var. Can be length 0 (which means no default).

getAllowedValues

public java.util.List<TemplateVariableValue> getAllowedValues()

The allowed values for this var. Can be length 0 (which means anything is allowed OR the list was too long).