| Method Summary |
|
| public void | add(Object obj)
Figure out what obj is and add it. |
| public void | addFormula(Formula f)
|
| public void | addGroup(Group g)
|
| public void | addParameter(Parameter p)
|
| public void | addSubreport(Subreport sub)
|
| public void | addUserColumn(UserColumn uc)
|
| protected void | askForDataSourceFile()
Asks the user for a data source file if necessary. |
| protected void | askForParameters()
Asks the user for parameter values. |
| public void | askForPassword(Database db)
Sets a database's user name and password. |
| public boolean | caseSensitiveDatabaseNames()
Returns the value of the caseSensitiveDatabaseNames flag. |
| protected void | collectAggregateFields()
Collects all aggregate fields and lets each one initialize itself. |
| protected List | collectUsedParameters()
Returns a list of all the parameters actually used in the report. |
| public Object | columnValue(Selectable selectable)
Returns the current value of the specified selectable. |
| public boolean | contains(Section s)
Returns true if this report contains the specified section. |
| public boolean | contains(Field f)
Returns true if the specified field exists within this
report. |
| public boolean | containsReferenceTo(Field f)
Returns true if the specified field exists within this
report either directly (as a field) or indirectly (as a formula used
by a aggregate, parameter, user column, or another formula). |
| public boolean | containsReferenceTo(Formula f)
Returns true if the specified formula exists within this
report either directly (as a formula field) or indirectly (as a formula
used by a aggregate or by another formula). |
| public boolean | containsReferenceTo(UserColumn uc)
Returns true if the specified user column exists within
this report either directly (as a user column field) or indirectly
(inside a aggregate or formula). |
| public boolean | containsReferenceTo(Parameter p)
Returns true if the specified parameter exists within this
report either directly (as a parameter field) or indirectly (as a
parameter used by a aggregate or by another parameter or in the query's
where clause). |
| public int | countGroups()
|
| public SectionArea | details()
|
| public Object | eval(String language, String evalString, String displayName)
Evaluates an evalString using language and returns
the results. |
| public void | evaluateFormulasIn(Section s)
Evalues the formulas in the specified section. |
| public Column | findColumn(String id)
Given an id (a column name), returns the column that has that id. |
| public Field | findField(Object id)
Given an id, returns the field that has that id. |
| public Formula | findFormula(Object id)
Returns the formula with the specified id or null
if one is not found. |
| public Formula | findFormulaByName(String name)
Returns the formula with the specified name or null
if one is not found. |
| public Group | findGroup(Selectable selectable)
Returns the group associated with the specified column, or
null if there isn't one. |
| public Group | findGroup(Section section)
Returns the group associated with the specified section, or
null if there isn't one. |
| public Parameter | findParameter(Object id)
Returns the parameter with the specified id or null if one is
not found. |
| public Parameter | findParameterByName(String name)
Returns the parameter with the specified name or null
if one is not found. |
| public Selectable | findSelectable(Object id, String type)
|
| public Subreport | findSubreport(Object id)
Returns the subreport with the specified id or null
if one is not found. |
| public UserColumn | findUserColumn(Object id)
Returns the user column with the specified id or null
if one is not found. |
| public UserColumn | findUserColumnByName(String name)
Returns the user column with the specified name or null
if one is not found. |
| public SectionArea | footers()
|
| public Iterator | formulas()
|
| public Long | generateNewFormulaId()
Generates and returns a new unique formula id number. |
| protected Long | generateNewId(Iterator iter)
Generates and returns a new unique id number. |
| public Long | generateNewParameterId()
Generates and returns a new unique parameter id number. |
| public Long | generateNewSubreportId()
Generates and returns a new unique user column id number. |
| public Long | generateNewUserColumnId()
Generates and returns a new unique user column id number. |
| public AbstractList | getAggregateFieldsFor(Field field)
Collects all aggregate fields that are aggregating the specified field. |
| public String | getAuthor()
|
| public DataCursor | getCurrentRow()
Returns the current row of data. |
| public DataSource | getDataSource()
|
| public Field | getDefaultField()
Returns the field that holds default format, border, and bounds values for
all fields. |
| public String | getDescription()
|
| protected Frame | getDesignFrame()
Returns the Frame associated with the design window for
this report; may be null. |
| public Section | getFirstSectionByArea(int area)
Returns the first section in the list of the specified type. |
| public String | getName()
|
| public PaperFormat | getPaperFormat()
|
| public Object | getParameterValue(Object paramId)
Returns the value of the specified parameter. |
| public Scripting | getScripting()
|
| public SectionArea | getSectionArea(int area)
Returns the section area corresponding to area, but
only if area is not group header or group footer. |
| public ReportSectionLoc | getSectionLocation(Section s)
Returns a structure useful only by this report for re-inserting a section.
This structure may later be passed to
Report.reinsertSection . |
| public Formula | getStartFormula()
Returns the report's start formula; may be null. |
| public String | getTitle()
|
| public Iterator | groups()
|
| public Iterator | groupsReversed()
Returns an iterator over the groups in reverse order. |
| public boolean | hasDataSource()
|
| public boolean | hasFields()
Returns true if this report contains some field anywhere. |
| public boolean | hasGroups()
|
| public boolean | hasParameterFields()
Returns true if this report contains some parameter field
anywhere. |
| public SectionArea | headers()
|
| public void | initializeSections()
|
| public Group | innermostGroup()
Returns the last (innermost) group in the report, or null
if there are no groups. |
| public Section | insertSectionBelow(Section goBelowThis)
Creates and returns a new section below the specified one. |
| public Section | insertSectionBelow(Section section, Section goBelowThis)
Inserts a (possibly newly created) section below the specified one. |
| public boolean | isInsideGroup(Section section)
Returns true if the specified section is contained in
any group. |
| public boolean | isOneOfAKind(Section s)
Returns true if the specified section is the only section
of its kind; that is, the only section in the collection in which it
is contained. |
| public boolean | isUsedBySomeGroup(Selectable g)
Returns true if the specified data source column is a
group column. |
| public SectionArea | pageFooters()
|
| public SectionArea | pageHeaders()
|
| public int | pageNumber()
Returns the current page number. |
| public Iterator | parameters()
|
| public void | parametersSetManually(boolean val)
Lets the caller tell the report to ask for parameters (val is
false, the default value) or to not ask (val is
true). |
| protected void | processResultRow()
Processes a single data source row. |
| public void | read(File f)
Reads an XML file and builds the contents of this report. |
| public void | read(org.xml.sax.InputSource in)
Reads an XML stream using a org.xml.sax.InputSource and
builds the contents of this report. |
| public void | reinsertSection(ReportSectionLoc loc)
Reinserts a section based on the location information previously retrieved
by a call to
Report.getSectionLocation . |
| public void | reloadColumns()
Tells this report to reload all references to column objects. |
| public void | remove(Object obj)
Figure out what obj is and remove it. |
| public void | removeAllGroups()
|
| public void | removeField(Field f)
|
| public void | removeFormula(Formula f)
|
| public void | removeGroup(Group g)
|
| public void | removeParameter(Parameter p)
|
| public void | removeSection(Section s)
Removes the specified section. |
| public void | removeSubreport(Subreport sub)
|
| public void | removeUserColumn(UserColumn uc)
|
| protected void | resetCachedValues()
Tells each formula that it should re-evaluate. |
| public int | rowNumber()
Returns the current data row number. |
| public void | run()
Spawns a new thread that runs the report, using the layout engine to
generate output. |
| public void | runReport()
Runs the data source's query and hands rows to the layout engine. |
| public Section | sectionContaining(Field f)
Returns the section containing the specified field, or null
if the field is not in the report. |
| public void | setAuthor(String newAuthor)
|
| public void | setCaseSensitiveDatabaseNames(boolean val)
Sets the value of caseSensitiveDatabaseNames. |
| public void | setDataSource(DataSource newDataSource)
Sets the data source. |
| public void | setDatabaseConnection(Connection conn)
Sets the database connection. |
| public void | setDatabasePassword(String pwd)
Sets the database password. |
| public void | setDescription(String newDescription)
|
| public void | setLayoutEngine(LayoutEngine layoutEngine)
Sets the layout engine to use. |
| public void | setName(String newName)
|
| public void | setPaperFormat(PaperFormat newPaperFormat)
|
| public void | setParameterXMLInput(File f)
Remembers name of parameter XML file. |
| public void | setParameterXMLInput(InputSource in)
Remembers an input source and reads parameter values from it later. |
| public void | setStartFormula(Formula newStartFormula)
|
| public void | setTitle(String newTitle)
|
| public Iterator | subreports()
|
| protected void | updateAggregates()
Updates each aggregate field. |
| protected void | updateGroupCounters()
Lets each group update its line counter. |
| protected void | updateGroups()
Updates each group's value based on the current value of the column
each group uses. |
| public Iterator | userColumns()
|
| public Object | value(String labelOrId)
Returns the value of the object (
Column ,
Formula ,
Parameter ,
UserColumn , or
SpecialField )
identified by labelOrId. |
| public void | withFieldsDo(FieldWalker f)
Iterates over all fields in the report, passing the section to the
specified FieldWalker. |
| public void | withSectionsDo(SectionWalker s)
Iterates over all sections in the report, passing the section to the
specified SectionWalker. |
| protected void | writeComment(XMLWriter out)
|
| protected void | writeDescription(XMLWriter out)
|
| public void | writeFile(String fileName)
Writes the contents of this report as an XML file. |
| protected void | writePage(XMLWriter out)
|
| protected void | writeReport(XMLWriter out)
|
| protected void | writeStartFormula(XMLWriter out)
|
| public void | writeXML(XMLWriter out)
Writes the contents of this report as an XML file. |
| protected void | writeXMLDecl(XMLWriter out)
|
