Package org.eclipse.mat.report
Class Spec
- java.lang.Object
-
- org.eclipse.mat.report.Spec
-
- All Implemented Interfaces:
IResult
- Direct Known Subclasses:
QuerySpec
,SectionSpec
public class Spec extends java.lang.Object implements IResult
A container for combining results.
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.lang.String
getName()
java.util.Map<java.lang.String,java.lang.String>
getParams()
Get the entire set of parameters.ResultMetaData
getResultMetaData()
(Optionally) Return meta data of the result needed to fine-tune the display of the result.java.lang.String
getTemplate()
void
merge(Spec other)
Merge with another Spec.void
putAll(java.util.Map<java.lang.String,java.lang.String> map)
Add an entire map of a parameter names and values.void
set(java.lang.String key, java.lang.String value)
Set a parameter to control the formatting of a reportvoid
setName(java.lang.String name)
void
setTemplate(java.lang.String template)
-
-
-
Method Detail
-
getResultMetaData
public ResultMetaData getResultMetaData()
Description copied from interface:IResult
(Optionally) Return meta data of the result needed to fine-tune the display of the result. This could include an additional context, an additional query to run on selected data from the result , additional calculated columns, or an indication that the results are already presorted.- Specified by:
getResultMetaData
in interfaceIResult
- Returns:
- the metadata for the result, used to obtain extra data
-
getName
public java.lang.String getName()
-
setName
public void setName(java.lang.String name)
-
getTemplate
public java.lang.String getTemplate()
-
setTemplate
public void setTemplate(java.lang.String template)
-
getParams
public java.util.Map<java.lang.String,java.lang.String> getParams()
Get the entire set of parameters.- Returns:
- the parameters
-
putAll
public void putAll(java.util.Map<java.lang.String,java.lang.String> map)
Add an entire map of a parameter names and values.- Parameters:
map
- a map of names and associated values
-
set
public void set(java.lang.String key, java.lang.String value)
Set a parameter to control the formatting of a report- Parameters:
key
- aParams
valuevalue
- the value which controls an aspect of the report
-
merge
public void merge(Spec other)
Merge with another Spec. Combine the parameters and choose the other name if this has none.- Parameters:
other
- the other Spec
-
-