|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectnet.sf.jasperreports.engine.base.JRBaseDataset
net.sf.jasperreports.engine.design.JRDesignDataset
Implementation of JRDataset
to be used for report desing.
Field Summary | |
protected java.util.List |
fieldsList
|
protected java.util.Map |
fieldsMap
Fields mapped by name. |
protected java.util.List |
groupsList
|
protected java.util.Map |
groupsMap
Groups mapped by name. |
protected java.util.List |
parametersList
|
protected java.util.Map |
parametersMap
Parameters mapped by name. |
protected java.util.List |
variablesList
|
protected java.util.Map |
variablesMap
Variables mapped by name. |
Fields inherited from class net.sf.jasperreports.engine.base.JRBaseDataset |
fields, groups, isMain, name, parameters, query, resourceBundle, scriptletClass, variables, whenResourceMissingType |
Fields inherited from interface net.sf.jasperreports.engine.JRDataset |
WHEN_RESOURCE_MISSING_TYPE_EMPTY, WHEN_RESOURCE_MISSING_TYPE_ERROR, WHEN_RESOURCE_MISSING_TYPE_KEY, WHEN_RESOURCE_MISSING_TYPE_NULL |
Constructor Summary | |
JRDesignDataset(boolean isMain)
Create a dataset. |
Method Summary | |
void |
addField(JRField field)
Adds a field to the dataset. |
void |
addGroup(JRDesignGroup group)
Adds a group to the dataset. |
void |
addParameter(JRParameter parameter)
Adds a parameter to the dataset. |
void |
addVariable(JRDesignVariable variable)
Adds a variable to the dataset. |
JRField[] |
getFields()
Returns the dataset's fields. |
java.util.List |
getFieldsList()
Returns the list of fields. |
java.util.Map |
getFieldsMap()
Returns the map of fields indexed by name. |
JRGroup[] |
getGroups()
Returns the dataset's groups. |
java.util.List |
getGroupsList()
Returns the list of groups. |
java.util.Map |
getGroupsMap()
Returns the map of groups indexed by name. |
JRParameter[] |
getParameters()
Returns the dataset's parameters. |
java.util.List |
getParametersList()
Returns the list of parameters, including build-in ones. |
java.util.Map |
getParametersMap()
Returns the map of parameters, including build-in ones, indexed by name. |
JRVariable[] |
getVariables()
Returns the dataset's variables. |
java.util.List |
getVariablesList()
Returns the list of variables, including build-in ones. |
java.util.Map |
getVariablesMap()
Returns the map of variable, including build-in ones, indexed by name. |
JRField |
removeField(JRField field)
Removes a field from the dataset. |
JRField |
removeField(java.lang.String fieldName)
Removes a field from the dataset. |
JRGroup |
removeGroup(JRGroup group)
Removes a group from the dataset. |
JRGroup |
removeGroup(java.lang.String groupName)
Removes a group from the dataset. |
JRParameter |
removeParameter(JRParameter parameter)
Removes a parameter from the dataset. |
JRParameter |
removeParameter(java.lang.String parameterName)
Removes a parameter from the dataset. |
JRVariable |
removeVariable(JRVariable variable)
Removes a variable from the dataset. |
JRVariable |
removeVariable(java.lang.String variableName)
Removes a variable from the dataset. |
void |
setName(java.lang.String name)
Sets the name of the dataset. |
void |
setQuery(JRQuery query)
Sets the dataset query. |
void |
setResourceBundle(java.lang.String resourceBundle)
Sets the base name of resource bundle to be used by the dataset. |
void |
setScriptletClass(java.lang.String scriptletClass)
Sets the scriptlet class name. |
Methods inherited from class net.sf.jasperreports.engine.base.JRBaseDataset |
getName, getQuery, getResourceBundle, getScriptletClass, getWhenResourceMissingType, isMainDataset, setWhenResourceMissingType |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
protected java.util.Map parametersMap
protected java.util.List parametersList
protected java.util.Map fieldsMap
protected java.util.List fieldsList
protected java.util.Map variablesMap
protected java.util.List variablesList
protected java.util.Map groupsMap
protected java.util.List groupsList
Constructor Detail |
public JRDesignDataset(boolean isMain)
isMain
- whether this is the main dataset of the report or a sub datasetJRDataset.isMainDataset()
Method Detail |
public void setName(java.lang.String name)
name
- the name of the datasetJRDataset.getName()
public JRParameter[] getParameters()
JRDataset
getParameters
in interface JRDataset
getParameters
in class JRBaseDataset
public java.util.List getParametersList()
JRParameter
objectspublic java.util.Map getParametersMap()
JRParameter
objects indexed by namepublic void addParameter(JRParameter parameter) throws JRException
parameter
- the parameter to add
JRException
JRDataset.getParameters()
public JRParameter removeParameter(java.lang.String parameterName)
parameterName
- the parameter name
null
if the parameter was not foundpublic JRParameter removeParameter(JRParameter parameter)
parameter
- the parameter to be removed
public void setQuery(JRQuery query)
query
- the queryJRDataset.getQuery()
public void setScriptletClass(java.lang.String scriptletClass)
If no scriptlet class name is specified, a default scriptlet is used.
scriptletClass
- the class name of the scriptletJRDataset.getScriptletClass()
public JRField[] getFields()
JRDataset
getFields
in interface JRDataset
getFields
in class JRBaseDataset
public java.util.List getFieldsList()
JRField
objectspublic java.util.Map getFieldsMap()
JRField
objects indexed by namepublic void addField(JRField field) throws JRException
field
- the field to add
JRException
JRDataset.getFields()
public JRField removeField(java.lang.String fieldName)
fieldName
- the field name
null
if the field was not foundpublic JRField removeField(JRField field)
field
- the field to be removed
public JRVariable[] getVariables()
JRDataset
getVariables
in interface JRDataset
getVariables
in class JRBaseDataset
public java.util.List getVariablesList()
JRVariable
objectspublic java.util.Map getVariablesMap()
JRVariable
objects indexed by namepublic void addVariable(JRDesignVariable variable) throws JRException
variable
- the variable to add
JRException
JRDataset.getVariables()
public JRVariable removeVariable(java.lang.String variableName)
variableName
- the variable name
null
if the variable was not foundpublic JRVariable removeVariable(JRVariable variable)
variable
- the variable to be removed
public JRGroup[] getGroups()
JRDataset
getGroups
in interface JRDataset
getGroups
in class JRBaseDataset
public java.util.List getGroupsList()
JRGroup
objectspublic java.util.Map getGroupsMap()
JRGroup
objects indexed by namepublic void addGroup(JRDesignGroup group) throws JRException
group
- the group to add
JRException
JRDataset.getGroups()
public JRGroup removeGroup(java.lang.String groupName)
groupName
- the group name
null
if the group was not foundpublic JRGroup removeGroup(JRGroup group)
group
- the group to be removed
public void setResourceBundle(java.lang.String resourceBundle)
resourceBundle
- the resource bundle base name
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |