Package com.inet.report
Class TableSource
java.lang.Object
com.inet.report.TableSource
- All Implemented Interfaces:
NodeParser
,com.inet.report.ReferenceHolder
,Serializable
public class TableSource
extends Object
implements Serializable, com.inet.report.ReferenceHolder, NodeParser
A TableSource is the representation of a table, a view, a stored procedure or a SQL command.
The table description contains of the table name, the alias and the column description.
Every datasource will be represented as a single table in the report design.
Thereby it is possible to use all tables, stored procedures and SQL statements in one report together.
The result of that are multiple requests to the database. Then results of the requests will be joined together by i-net Clear Reports.
Example code:
Example code:
Add a table to the reportDatabaseTables dbTables = engine.getDatabaseTables(); Datasource ds = dbTables.createDatasource("pdssql.dll","localhost","","Northwind","sa","MyPassword"); //adding a TableSource to the Datasource TableSource tabOrderDetails = ds.createTableSource("Order Details"); tabOrderDetails.addColumn("OrderId",Field.NUMBER); tabOrderDetails.addColumn("ProductId",Field.NUMBER); tabOrderDetails.addColumn("UnitPrice",Field.NUMBER); tabOrderDetails.addColumn("Quantity",Field.NUMBER); tabOrderDetails.addColumn("OrderId",Field.NUMBER); tabOrderDetails.addColumn("Discount",Field.NUMBER); //to receive the DatabaseField of column "OrderId call: tabOrderDetails.getDatabaseField(tabOrderDetails.getColumnName(0));
Add a stored procedure to the report:TableSource sp_salesByYear = ds.createTableSource("Sales By Year"); //add the result columns to the stored procedure sp_salesByYear.addColumn("ShippedDate", Field.DATETIME); sp_salesByYear.addColumn("OrderID", Field.NUMBER); sp_salesByYear.addColumn("Subtotal", Field.NUMBER); sp_salesByYear.addColumn("Year", Field.STRING); //define the input parameter of the stored procedure String[] inputParamNames = new String[]{"Beginning_Date","Ending_Date"}; int[] inputParamTypes = new int[]{Field.DATETIME,Field.DATETIME}; sp_salesByYear.setInputParameter(inputParamNames,inputParamTypes);
Add a SQL command to the report:TableSource cmdOrderDetails = ds.createTableSource("Order Details"); //Hint:
If the Datasource of the TableSource can create a database Connection, you can use theDatasource.createTableSourceCommand(String, String)
adds the columns and DatabaseFields automatically. cmdOrderDetails.setSql("select * from \"Order Details\" where OrderId = {?OrderId}"); //add the required PromptField to the report cmdOrderDetails.setInputParameter( new String[]{"OrderId"}, new int[]{Field.NUMBER}); //add the result columns to the sql command cmdOrderDetails.addColumn("OrderId",Field.NUMBER); cmdOrderDetails.addColumn("ProductId",Field.NUMBER); cmdOrderDetails.addColumn("UnitPrice",Field.NUMBER); cmdOrderDetails.addColumn("Quantity",Field.NUMBER); cmdOrderDetails.addColumn("OrderId",Field.NUMBER); cmdOrderDetails.addColumn("Discount",Field.NUMBER);refresh()
to add a table or a stored procedure.DatabaseTables dbTables = engine.getDatabaseTables(); Datasource ds = dbTables.createDatasource("pdssql.dll","localhost","","Northwind","sa","MyPassword"); //adding a TableSource to the Datasource TableSource tabOrderDetails = ds.createTableSource("Order Details"); tabOrderDetails.refresh();//scans the table and adds all columns to TableSource
- Since:
- 6.0
- See Also:
-
Field Summary
Modifier and TypeFieldDescriptionstatic final int
Identifies a TableSource as a sql statement.static final String
The name of system table data source returning from meta data.static final String
The name of table data source returning from meta data.static final String
The name of view data source returning from meta data.static final int
Identifies a TableSource as a stored procedure.static final int
Identifies a TableSource as a table or a view. -
Method Summary
Modifier and TypeMethodDescriptionvoid
Adds a column to the table definition.void
Adds a column with column description to the table definition.final void
addReferencedObject
(com.inet.report.ReferencedObject reference) FOR INTERNAL USE ONLYvoid
canRemoveColumn
(String columnName) Checks the column of this table can be removed from the report.void
changeAliasReferences
(String newAlias) Changes the alias name to newAlias.static void
checkAliasValidity
(String newAlias) Checks the name for whether it is a valid name for this TableSource.void
Sends a test statement to the data source to check if the TableSource is executable.boolean
Checks whether the given Object is a TableSource object with the same alias name.getAlias()
Returns the alias name.int
Returns the number of columns.getColumnName
(int idx) Returns the column name of the selected column.String[]
Returns an array of all column names.int
getColumnType
(int idx) Returns the column type of the selected column.int[]
Returns an array of all column types.getDatabaseField
(int idx) Returns the corresponding DatabaseField to that column index.getDatabaseField
(String columnName) Returns the corresponding DatabaseField to that column name.Returns all DatabaseFields that belongs to this TableSource.Returns the original name of the table source.Returns the Datasource object, to which this TableSource belongs.Returns the list ofPromptField
s which are used by this table source as store procedures parameter.boolean
Get the value if a string prompts in a SQL statement should be quoted or not.final int
FOR INTERNAL USE ONLYfinal int
FOR INTERNAL USE ONLYfinal com.inet.report.ReferencedObject[]
FOR INTERNAL USE ONLY@Nonnull ResultSet
Returns the ResultSet of that TableSource.getSql()
Returns the SQL command if it was set.Returns the SQL command if it was set.int
getType()
Returns the type of that TableSource.boolean
FOR INTERNAL USE ONLY Internal method for reading report XMLboolean
isUsed()
Returns the columns of this report are used in the report or this table is used in a join.void
FOR INTERNAL USE ONLY Internal method for reading report XMLparseElement
(com.inet.report.parser.XMLTag group, String tag, Attributes atts, Map<String, Object> parserMap) FOR INTERNAL USE ONLY Internal method for reading report XMLvoid
parseEndElement
(com.inet.report.parser.XMLTag group, String tag, Map<String, Object> parserMap) FOR INTERNAL USE ONLY Internal method for reading report XMLvoid
FOR INTERNAL USE ONLY Internal method for reading report XMLvoid
refresh()
Refreshs the columns of the TableSource by requesting meta information from the database.
If the TableSource is of typeTYPE_TABLE_OR_VIEW
, the following query will send to database to find out the columns of the table:
"select * from "+this.getDatabaseIdentifier()+" where 1=0"
In a similar way the columns ofTYPE_COMMAND
will requested.void
removeColumn
(String columnName) Removes a specific column.
If the column is only used as join condition, the join condition will be removed.final void
removeReferencedObject
(com.inet.report.ReferencedObject reference) FOR INTERNAL USE ONLYfinal void
FOR INTERNAL USE ONLYvoid
setDatabaseIdentifierName
(String newDatabaseIdentifier) Sets the identifier name of the TableSource.void
setInputParameter
(String[] paramNames, int[] paramTypes) Defines the input parameter for this TableSource.void
setInputParameter
(String[] paramNames, int[] paramTypes, Object[] values) Defines the input parameter for this TableSource.void
setInputParameter_TypesOfSQLType
(String[] paramNames, int[] paramTypes) Deprecated.void
setInputParameter_TypesOfSQLType
(String[] paramNames, int[] paramTypes, Object[] values) Deprecated.As of i-net Clear Reports 15, instead usesetInputParameter(String[], int[], Object[])
void
setLocation
(String location, Datasource newDatasource) Set the location information of the identifier.void
setQuoteStringPrompts
(boolean value) Set if a string prompts in a SQL statement should be quoted or not.final void
FOR INTERNAL USE ONLYvoid
Sets the SQL statement and changes the type of this TableSource toTYPE_COMMAND
.
Note: This method does not check if the sql statement is correct or which columns it will receive.toString()
Returns the alias name.
-
Field Details
-
TYPE_TABLE_OR_VIEW
public static final int TYPE_TABLE_OR_VIEWIdentifies a TableSource as a table or a view.- See Also:
-
TYPE_PROCEDURE
public static final int TYPE_PROCEDUREIdentifies a TableSource as a stored procedure.- See Also:
-
TYPE_COMMAND
public static final int TYPE_COMMANDIdentifies a TableSource as a sql statement.- See Also:
-
TYPE_NAME_TABLE
The name of table data source returning from meta data.- See Also:
-
TYPE_NAME_VIEW
The name of view data source returning from meta data.- See Also:
-
TYPE_NAME_SYSTEM_TABLE
The name of system table data source returning from meta data.- See Also:
-
-
Method Details
-
getType
Returns the type of that TableSource. Possible are three types. If there is a SQL Statement, the TableSource is from type TYPE_COMMAND. Otherwise it is from type TYPE_PROCEDURE or TYPE_TABLE_OR_VIEW. To find out, which of both it is, the TableSource have to request the DatabaseMetaData. So it is possible to use on one database a view and on an other database instead of the view a stored procedure, if both have same name.- Returns:
- The type of this TableSource.
- Throws:
ReportException
- if there occurs a problem while creating the Connection- Since:
- 6.0
- See Also:
-
getResultSet
Returns the ResultSet of that TableSource. If the TableSource is from TYPE_COMMAND or from TYPE_PROCEDURE, the Statement will be executed directly and the ResultSet contains all columns.
If the stored procedure needs input parameter, it reads the values from the according prompt fields. If the TableSource is from type TYPE_TABLE_OR_VIEW, only these columns will be requested, that are needed in the report.- Returns:
- the ResultSet for that TableSource
- Throws:
ReportException
- if there occur a problem on create the ConnectionSQLException
- if there occur a problem on execute the Statement.- Since:
- 6.0
-
checkExistsOnCurrentDatasource
Sends a test statement to the data source to check if the TableSource is executable.- Throws:
ReportException
- If the TableSource is not executable on the data source OR if creating the Connection to the data source failed.- Since:
- 6.0
-
addColumn
Adds a column to the table definition.- Parameters:
columnName
- The column namecolumnType
- The i-net Clear Reports value type- Throws:
ReportException
- when columnType is not valid- Since:
- 6.0
- See Also:
-
addColumn
Adds a column with column description to the table definition. The label is an additional information only that can be used to explain abstract column names. This label will be used from i-net Designer for example. It don't influence the SQL generation.- Parameters:
columnName
- The column namecolumnType
- The i-net Clear Reports value typecolumnLabel
- additional information that can be used to explain abstract column names- Throws:
ReportException
- when columnType is not valid- Since:
- 7.0
- See Also:
-
getDatabaseField
Returns the corresponding DatabaseField to that column index.- Parameters:
idx
- A 0-based index of DatabaseField.- Returns:
- The corresponding DatabaseField to that column index.
- Since:
- 9.0
- See Also:
-
getDatabaseField
Returns the corresponding DatabaseField to that column name.- Parameters:
columnName
- A column of this TableSource.- Returns:
- The corresponding DatabaseField to that column name or null if column is not defined.
- Since:
- 6.1
- See Also:
-
getDatabaseFields
Returns all DatabaseFields that belongs to this TableSource.- Returns:
- All DatabaseFields that belongs to this TableSource.
- Since:
- 6.1
- See Also:
-
getColumnName
Returns the column name of the selected column.- Parameters:
idx
- The 0-based index of a column name.- Returns:
- The column name of the selected column.
- Since:
- 6.0
- See Also:
-
getColumnNames
Returns an array of all column names.- Returns:
- An array of all column names.
- Since:
- 6.0
-
getColumnTypes
public int[] getColumnTypes()Returns an array of all column types.- Returns:
- An array of all column types.
- Since:
- 6.0
-
getColumnType
Returns the column type of the selected column.- Parameters:
idx
- index of the column- Returns:
- The column type of the selected column.
- Throws:
IndexOutOfBoundsException
- - if index is out of range (index < 0 || index >= getColumnCount())- Since:
- 6.0
- See Also:
-
removeColumn
Removes a specific column.
If the column is only used as join condition, the join condition will be removed.- Parameters:
columnName
- Column name to be removed.- Throws:
ReportException
- If the column is used in the report.- Since:
- 6.0
- See Also:
-
canRemoveColumn
Checks the column of this table can be removed from the report. Throws a exception if the column is used.- Parameters:
columnName
- the short column name- Throws:
ReportException
- if the column is used and cannot be removed- Since:
- 10.0
-
checkAliasValidity
Checks the name for whether it is a valid name for this TableSource. Aliases may not be empty or null, must start with a letter or a square bracket, and must contain only letters, digits, or one of the following characters: _;-$] They also may not be any SQL keywords. If the name is invalid, this method will throw a ReportException.- Parameters:
newAlias
- alias name to check- Throws:
ReportException
- if the name is not valid- Since:
- 11.1
-
changeAliasReferences
Changes the alias name to newAlias. This also updates all references to this source in all fields and joins.- Parameters:
newAlias
- Alias to be set- Throws:
ReportException
- If there is no such data source, or if there is a different problem- Since:
- 6.0
-
setDatabaseIdentifierName
Sets the identifier name of the TableSource. This is useful if the table name was changed in the database.- Parameters:
newDatabaseIdentifier
- The new identifier name of the TableSource.- Throws:
ReportException
- If the identifier name is empty.- Since:
- 6.0
-
getColumnCount
public int getColumnCount()Returns the number of columns.- Returns:
- the number of columns.
- Since:
- 6.0
-
getAlias
Returns the alias name. The name is a unique identifier of this tablesource.- Returns:
- the alias name.
- Since:
- 6.0
- See Also:
-
getDatabaseIdentifier
Returns the original name of the table source.- Returns:
- the original name of the table source.
- Since:
- 6.0
- See Also:
-
setLocation
Set the location information of the identifier. This is useful if the table was moved into another schema, catalog or package.Example 1:
//old identifier name = "SCOTT.MYTABLE" tableSource.setLocation("OTHERSCHEMA.MYPACKAGE", anOtherDatasource); //the new identifier name = "OTHERSCHEMA.MYPACKAGE.MYTABLE"
Example 2://old identifier name = "SCOTT.MYTABLE" tableSource.setLocation(null,null); //the new identifier name = "MYTABLE"
- Parameters:
location
- The location information of the identifier. Passingnull
will not change the location. Set empty String to remove the location information.newDatasource
- Set an other Datasource if the TableSource has to move from one Datasource to the other. Passingnull
will not move the TableSource.- Since:
- 6.0
-
toString
Returns the alias name. -
equals
Checks whether the given Object is a TableSource object with the same alias name. -
getSql
Returns the SQL command if it was set.- Returns:
- the SQL command if it was set.
- Since:
- 6.0
- See Also:
-
getSqlWithPromptFieldValues
Returns the SQL command if it was set. Placeholder for PromptFields are replaced by their value.- Returns:
- the SQL command if it was set. Placeholder for PromptFields are replaced by their value.
- Throws:
ReportException
- if SQL command contains invalid placeholder.- Since:
- 6.0
- See Also:
-
setSql
Sets the SQL statement and changes the type of this TableSource toTYPE_COMMAND
.
Note: This method does not check if the sql statement is correct or which columns it will receive.
You also have to add the columns of the statement manually. Add the columns in the same order like column order of the ResultSet.
The columns of the ResultSet of this sql statement have to be added to this TableSource in the same direction.
If you want to use the columns in the report, you also have to register them as DatabaseFields.
The easiest way to add a TableSource from TYPE_COMMAND is to use the Datasource.createTableSourceCommand(String,String) method.
Note: If report contains SortFields and GroupFields, the sort order given by statement may be changed.- Parameters:
newSql
- SQL Statement that will be used for this TableSource- Since:
- 6.0
- See Also:
-
setQuoteStringPrompts
public void setQuoteStringPrompts(boolean value) Set if a string prompts in a SQL statement should be quoted or not. The default is true. If you disable the quoting then SQL injection is possible.- Parameters:
value
- the new value- Since:
- 11.2
- See Also:
-
getQuoteStringPrompts
public boolean getQuoteStringPrompts()Get the value if a string prompts in a SQL statement should be quoted or not.- Returns:
- current value
- Since:
- 11.2
-
getDatasource
Returns the Datasource object, to which this TableSource belongs.- Returns:
- the Datasource object, to which this TableSource belongs.
- Since:
- 6.0
-
setInputParameter
Defines the input parameter for this TableSource. It creates PromptFields with a link to this TableSource. Input parameter are necessary for stored procedured or views with parameter. SQL commands also can contain placeholder for promptvalues.- Parameters:
paramNames
- The input parameter names.paramTypes
- The types of the input parameter. The type is a constant of class com.inet.report.Field.- Throws:
ReportException
- If type of parameter is unknown.- Since:
- 6.0
- See Also:
-
setInputParameter
public void setInputParameter(String[] paramNames, int[] paramTypes, Object[] values) throws ReportException Defines the input parameter for this TableSource. It creates PromptFields with a link to this TableSource. Input parameter are necessary for stored procedures or views with parameter. SQL commands also can contain placeholder for prompt values.
This method implicitly creates PromptFields and set the values.
Code sample for a simple stored procedure:String[] names = new String(){"costumerId","endDate"}; int[] types = new int(){Field.STRING,Field.DATE}; Object values = new Object("ALFKI",new Date(1999,11,11){}; //mySP has two input parameter and retunes a result set TableSource ts = datasource.createTableSource("mySP"); //creates PromptFields for this procedure and set values ts.setInputParameter_TypesOfSQLType(names,types,values); //executes the SP to scan returned columns. The parameter for execution were set before. ts.refresh();
- Parameters:
paramNames
- The input parameter names.paramTypes
- paramTypes The types of the input parameter. The type is a constant of class com.inet.report.Field.values
- values The values for set parameter.- Throws:
ReportException
- If type of parameter is unknown.- Since:
- 6.0
-
getInputParameters
Returns the list ofPromptField
s which are used by this table source as store procedures parameter.- Returns:
- the list (not
null
) - Throws:
ReportException
- will be thrown if the engine was invalid or finished- Since:
- 10.1
-
setInputParameter_TypesOfSQLType
@Deprecated public void setInputParameter_TypesOfSQLType(String[] paramNames, int[] paramTypes) throws ReportException Deprecated.As of i-net Clear Reports 15, instead usesetInputParameter(String[], int[])
Defines the input parameter for this TableSource. It creates PromptFields with a link to this TableSource. Input parameter are necessary for stored procedures or views with parameter. SQL commands also can contain placeholder for parameter values.
This method implicitly creates PromptFields and set the values.
Code sample for simple stored procedure:String[] names = new String(){"costumerId","endDate"}; int[] types = new int(){Types.VARCHAR,Types.DATE}; //mySP has two input parameter and retunes a result set TableSource ts = datasource.createTableSource("mySP"); //creates PromptFields for this procedure. ts.setInputParameter_TypesOfSQLType(names,types,values); //executes the SP to scan returned columns. The parameter for execution are sample values. ts.refresh();
- Parameters:
paramNames
- The input parameter names.paramTypes
- The types of the input parameter. The type is a constant of class java.sql.Types.- Throws:
ReportException
- if mapping from SQL type to Field type failed. If paramNames.length is different to paramTypes.length.- Since:
- 6.0
-
setInputParameter_TypesOfSQLType
@Deprecated public void setInputParameter_TypesOfSQLType(String[] paramNames, int[] paramTypes, Object[] values) throws ReportException Deprecated.As of i-net Clear Reports 15, instead usesetInputParameter(String[], int[], Object[])
Defines the input parameter for this TableSource. It creates PromptFields with a link to this TableSource. Input parameter are necessary for stored procedures or views with parameter. SQL commands also can contain placeholder for parameter values.
This method implicitly creates PromptFields and set the values.
Code sample for simple stored procedure:
Code sample for a stored procedure with out cursor:String[] names = new String(){"costumerId","endDate"}; int[] types = new int(){Types.VARCHAR,Types.DATE}; Object values = new Object("ALFKI",new Date(1999,11,11){}; //mySP has two input parameter and returns a result set TableSource ts = datasource.createTableSource("mySP"); //creates PromptFields for this procedure and set values ts.setInputParameter_TypesOfSQLType(names,types,values); //executes the SP to scan returned columns. The parameter for execution were set before. ts.refresh();
String[] names = new String(){"outcursor";"costumerId","endDate"}; int[] types = new int(){-10,Types.VARCHAR,Types.DATE};//-10 is out cursor , it is the standard value returned from oracle JDBC drivers Object values = new Object("ALFKI",new Date(1999,11,11){};//no value for out cursor or other out values //mySP2 has two input parameter and returns a result via out cursor TableSource ts = datasource.createTableSource("mySP2"); //creates PromptFields for this procedure and set values ts.setInputParameter_TypesOfSQLType(names,types,values); //executes the SP to scan returned columns. The parameter for execution were set before. ts.refresh();
- Parameters:
paramNames
- The input parameter names.paramTypes
- The types of the input parameter. The type is a constant of class java.sql.Types. The values -10(type oracle cursor) and 1111(type other) will be ignored.values
- The values for set parameter. Do not set values for out parameter or cursor parameter.- Throws:
ReportException
- if mapping from SQL type to Field type failed. If paramNames.length is different to paramTypes.length.- Since:
- 6.0
-
addReferencedObject
public final void addReferencedObject(com.inet.report.ReferencedObject reference) FOR INTERNAL USE ONLY- Specified by:
addReferencedObject
in interfacecom.inet.report.ReferenceHolder
- Since:
- 6.0
-
getReferencedObjects
public final com.inet.report.ReferencedObject[] getReferencedObjects()FOR INTERNAL USE ONLY- Specified by:
getReferencedObjects
in interfacecom.inet.report.ReferenceHolder
-
getRealReferencedObjectCount
public final int getRealReferencedObjectCount()FOR INTERNAL USE ONLY- Specified by:
getRealReferencedObjectCount
in interfacecom.inet.report.ReferenceHolder
- Since:
- 6.0
-
getReferencedObjectCount
public final int getReferencedObjectCount()FOR INTERNAL USE ONLY- Specified by:
getReferencedObjectCount
in interfacecom.inet.report.ReferenceHolder
-
removeReferencedObject
public final void removeReferencedObject(com.inet.report.ReferencedObject reference) FOR INTERNAL USE ONLY- Specified by:
removeReferencedObject
in interfacecom.inet.report.ReferenceHolder
- Since:
- 6.0
-
setReferences
public final void setReferences()FOR INTERNAL USE ONLY- Specified by:
setReferences
in interfacecom.inet.report.ReferenceHolder
-
resetReferences
public final void resetReferences()FOR INTERNAL USE ONLY- Specified by:
resetReferences
in interfacecom.inet.report.ReferenceHolder
-
refresh
Refreshs the columns of the TableSource by requesting meta information from the database.
If the TableSource is of typeTYPE_TABLE_OR_VIEW
, the following query will send to database to find out the columns of the table:
"select * from "+this.getDatabaseIdentifier()+" where 1=0"
In a similar way the columns ofTYPE_COMMAND
will requested. An algorithm includes a "1=0" filter clause in the statement.
If the TableSource is of typeTYPE_PROCEDURE
, the result of the sp will requested.
The parameter of the stored procedure are used from the refering PromptFields.
If the signature of the stored procedure has changed with additional input parameter, this methods adds new PromptFields to the report.
If an input parameter was removed from stored procedure signature, the refering PromptField will removed from report, but if the PromptField is used another where in the report.- Throws:
ReportException
- if a DatabaseField is used in report but the refering column does not exists on database.SQLException
- if connecting to database failed or if requesting meta information failed.- Since:
- 6.5
-
isDOMParser
public boolean isDOMParser()FOR INTERNAL USE ONLY Internal method for reading report XMLReturns whether this node is to be read via a DOM parser.
- Specified by:
isDOMParser
in interfaceNodeParser
- Returns:
- true if this node is to be read via a DOM parser, false otherwise.
-
parseDOM
FOR INTERNAL USE ONLY Internal method for reading report XMLParses the node.
- Specified by:
parseDOM
in interfaceNodeParser
- Parameters:
node
- the nodeparserMap
- The map of current Parser.- Throws:
FatalParserException
- if an exception occurs which causes the report to not be able to be read: causes the abortion of the reading of the report.
-
parseElement
public NodeParser parseElement(com.inet.report.parser.XMLTag group, String tag, Attributes atts, Map<String, Object> parserMap) throws FatalParserExceptionFOR INTERNAL USE ONLY Internal method for reading report XMLParses an XML node with the given information, and returns either a sub-element which was created as a result, or null if no sub-element was created, i.e. the information was applied to the ReportComponent itself. Note that the parsing is highly tolerant, i.e. exceptions are intercepted and suppressed if at all possible.
- Specified by:
parseElement
in interfaceNodeParser
- Parameters:
group
- XMLTag of the current node to be parsed, or null if there is no such current group. An XMLTag is a group of nodes bundled together, usually it is a Properties node such as CommonProperties, BorderProperties, etc.tag
- The XMLTag to be parsedatts
- The set of attributes in the current XMLTagparserMap
- The map of current Parser.- Returns:
- The NodeParser sub-element if one needed to be created, or null if none was created.
- Throws:
FatalParserException
- if an exception occurs which causes the report to not be able to be read: causes the abortion of the reading of the report.
-
parseEndElement
public void parseEndElement(com.inet.report.parser.XMLTag group, String tag, Map<String, Object> parserMap) throws FatalParserExceptionFOR INTERNAL USE ONLY Internal method for reading report XMLReceive notification of the end of an XML tag.
- Specified by:
parseEndElement
in interfaceNodeParser
- Parameters:
group
- XMLTag of the current node to be parsed, or null if there is no such current group.tag
- The XMLTag to be parsedparserMap
- The map of current Parser.- Throws:
FatalParserException
- if an exception occurs which causes the report to not be able to be read: causes the abortion of the reading of the report.
-
parseText
FOR INTERNAL USE ONLY Internal method for reading report XMLThis method is called if text was encountered in the context of this node. (Examples would be a formula's text or a text element's text)
- Specified by:
parseText
in interfaceNodeParser
- Parameters:
text
- text encountered and to be storedparserMap
- The map of current Parser.
-
isUsed
Returns the columns of this report are used in the report or this table is used in a join.- Returns:
- the flag
- Throws:
ReportException
- if engine is finished or no report is set.- Since:
- 11.0
-
setInputParameter(String[], int[])