Overview | Package | Class | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## jet.api
Class SummaryInfo

    java.lang.Object
      jet.api.SummaryInfo

    public class SummaryInfo

extends java.lang.Object

Constructor Summary
`SummaryInfo()` Constructor.
`SummaryInfo(java.lang.String name, java.lang.String desc, java.lang.String function, java.lang.String fieldName, java.lang.String groupby)` Constructor.

Method Summary
`java.lang.String` | `getDescription()` Gets Summary description
`java.lang.String` | `getField()` Gets Summary field name
`java.lang.String` | `getFunction()` Gets Summary function type
`java.lang.String` | `getGroupBy()` Gets Summary break-by field
`java.lang.String` | `getName()` Gets Summary Name
`SpecFuncInfo` | `getSpecFuncInfo()` Gets Special Function information
`void` | `setDescription(java.lang.String desc)` Sets Summary description
`void` | `setField(java.lang.String fieldName)` Sets Summary field
`void` | `setFunction(java.lang.String function)` Sets Summary function
`void` | `setGroupBy(java.lang.String groupby)` Sets Summary break-by field
`void` | `setName(java.lang.String name)` Sets Summary Name
`void` | `setSpecFuncInfo(SpecFuncInfo specFuncInfo)` Sets Special Function information

Methods inherited from class java.lang.Object
`equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

### SummaryInfo

    public SummaryInfo()

  Constructor. Creates the Summary infomation object.

### SummaryInfo

    public SummaryInfo(java.lang.String name,
                       java.lang.String desc,
                       java.lang.String function,
                       java.lang.String fieldName,
                       java.lang.String groupby)

  Constructor. Creates the Summary infomation object.

  Parameters:
    `name` - the name of the summary
    `desc` - the description of the summary
    `function` - the aggregate function
    `groupby` - the groupby field name
    `fieldName` - the name of the field which is calculated

Method Detail

### getName

    public java.lang.String getName()

  Gets Summary Name

  Returns:
    Summary name

### setName

    public void setName(java.lang.String name)

  Sets Summary Name

  Parameters:
    `name` - Summary name

### getDescription

    public java.lang.String getDescription()

  Gets Summary description

  Returns:
    Summary description text

### setDescription

    public void setDescription(java.lang.String desc)

  Sets Summary description

  Parameters:
    `desc` - Summary description

### getFunction

    public java.lang.String getFunction()

  Gets Summary function type

  Returns:
    Summary type text

### setFunction

    public void setFunction(java.lang.String function)

  Sets Summary function

  Parameters:
    `function` - Summary function type

### getField

    public java.lang.String getField()

  Gets Summary field name

  Returns:
    Summary field name

### setField

    public void setField(java.lang.String fieldName)

  Sets Summary field

  Parameters:
    `fieldName` - Summary field name

### getGroupBy

    public java.lang.String getGroupBy()

  Gets Summary break-by field

  Returns:
    Summary break-by field name

### setGroupBy

    public void setGroupBy(java.lang.String groupby)

  Sets Summary break-by field

  Parameters:
    `groupby` - Summary break-by field name

### getSpecFuncInfo

    public SpecFuncInfo getSpecFuncInfo()

  Gets Special Function information

  Returns:
    Special Function information

### setSpecFuncInfo

    public void setSpecFuncInfo(SpecFuncInfo specFuncInfo)

  Sets Special Function information

  Parameters:
    `specFuncInfo` - Special Function information

Overview | Package | Class | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD