|
Style Intelligence v12.0 | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectinetsoft.report.XSessionManager
public class XSessionManager
XSessionManager provides the API for processing report data queries. It can be used to find all query parameters, or execute the queries and populate the report with query output. It supports all queries bound to a report element through the Designer.
If a report has query binding defined in the designer, the report must be executed using XSessionManager before it is processed. Otherwise the queries are not executed.
| Field Summary | |
|---|---|
static int |
ALL_PARAMETER
All parameter flag. |
static String |
CACHED_DATA
Cached data hint. |
static int |
NO_EXECUTING
Flag indicates not to execute parameters. |
static int |
QUERY_PARAMETER
Query parameter flag. |
static int |
REPORT_CONDITION_PARAMETER
Report condition parameter flag. |
static int |
USER_DEFINED_PARAMETER
User defined parameter flag. |
| Constructor Summary | |
|---|---|
XSessionManager()
Create a session manager with specific key. |
|
XSessionManager(XDataService service,
Object session)
Create a session manager from a data service and session. |
|
| Method Summary | |
|---|---|
void |
bind(Object uinfo)
Bind to the data service engine. |
void |
cancel(ReportSheet report)
Cancel report and clean up background queries if supported. |
static void |
clear()
Clear cached session manager. |
void |
clearCache()
Clear data cache. |
void |
destroyReport(ReportSheet report)
Destroy report to clear up temporary resources. |
protected void |
execute(inetsoft.report.internal.BindableElement elem,
inetsoft.report.internal.binding.BindingAttr binding,
VariableTable vars,
Principal user,
Hashtable queries)
Execute a query on an element. |
boolean |
execute(ReportSheet report)
Execute a report. |
protected boolean |
execute(ReportSheet report,
boolean force)
Execute a report. |
protected void |
execute(ReportSheet report,
ReportElement elem,
VariableTable vars,
Vector chart_tables,
Principal user,
String[] qrs,
Hashtable queries)
Execute an element. |
void |
execute(ReportSheet report,
VariableTable vars)
Execute a report. |
void |
execute(ReportSheet report,
VariableTable vars,
Principal user)
Execute a report. |
void |
execute(ReportSheet report,
VariableTable vars,
Principal user,
String[] qrs)
Execute a report. |
void |
executeChoiceQuery(UserVariable var,
XQueryRepository rep)
Execute queries for selection list parameters and populate choice list. |
void |
executeChoiceQuery(UserVariable var,
XQueryRepository rep,
String ename)
Execute queries for selection list parameters and populate choice list. |
void |
finalize()
Clean up. |
protected inetsoft.report.internal.binding.BindingAttr |
getBindingAttr(ReportElement elem)
Get source attr from a report element. |
XDataService |
getDataService()
Get the data source object of this session manager. |
static List |
getExecutingQueries()
Get the ids of all executing queries during a sample period. |
UserVariable[] |
getQueryParameters(ReportSheet report,
boolean promptOnly)
Get the query parameters in the report. |
UserVariable[] |
getQueryParameters(ReportSheet report,
boolean promptOnly,
int pflag)
Get the query parameters in the report. |
UserVariable[] |
getQueryParameters(ReportSheet report,
boolean promptOnly,
int pflag,
VariableTable nopromptVars)
Get the query parameters in the report. |
String |
getQueryVariableName(String qname,
String vname)
Get query variable name. |
Object |
getSession()
Get the session object of this session. |
static XSessionManager |
getSessionManager()
Get a singlton session manager. |
XNodeTableLens |
getXNodeTableLens(XQuery query,
VariableTable qvars,
Principal user)
Get the XNodeTableLens from a query. |
XNodeTableLens |
getXNodeTableLens(XQuery query,
VariableTable qvars,
Principal user,
XQueryRepository rep,
Hashtable queries)
Get the XNodeTableLens from a query. |
XNodeTableLens |
getXNodeTableLens(XQuery query,
VariableTable qvars,
Principal user,
XQueryRepository rep,
Hashtable queries,
long ts)
Get the XNodeTableLens from a query. |
boolean |
isCacheData()
Check if query result should be cached. |
boolean |
isVariableNameUnique()
Check if the query variable names are unique. |
TableLens |
performJoins(TableLens baseTable,
VariableTable vars,
inetsoft.report.internal.binding.BindingAttr binding,
inetsoft.report.internal.BindableElement elem,
Principal user)
Create join tables by executing the joined query and join with the base table. |
void |
prepareJoinBinding(inetsoft.report.internal.binding.BindingAttr binding,
ReportSheet report)
Prepare the BindingAttr for joining. |
XQuery |
prepareQuery(ReportElement elem,
VariableTable vars)
Create or retrieve query for an element. |
static void |
removeQueryInfo(String queryId)
Remove the query info from the current static query map. |
static void |
restart()
Restart the session manager. |
void |
setCacheData(boolean useCache)
Set if query result should be cached. |
void |
setDataService(XDataService service)
Set the data source object of this session manager. |
void |
setSession(Object session)
Set the session object of this session. |
void |
setVariableNameUnique(boolean unique)
Set if the query variable names are unique. |
void |
tearDown()
Tear down manager. |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
|---|
public static final int QUERY_PARAMETER
public static final int REPORT_CONDITION_PARAMETER
public static final int USER_DEFINED_PARAMETER
public static final int ALL_PARAMETER
public static final int NO_EXECUTING
public static final String CACHED_DATA
| Constructor Detail |
|---|
public XSessionManager()
throws RemoteException
RemoteException
public XSessionManager(XDataService service,
Object session)
| Method Detail |
|---|
public static XSessionManager getSessionManager()
throws RemoteException
RemoteExceptionpublic static void clear()
public static void restart()
public void tearDown()
public XDataService getDataService()
public void setDataService(XDataService service)
public Object getSession()
public void setSession(Object session)
public boolean isVariableNameUnique()
public void setVariableNameUnique(boolean unique)
public void bind(Object uinfo)
throws RemoteException
uinfo - user information. Must be unique in each session.
RemoteException
public UserVariable[] getQueryParameters(ReportSheet report,
boolean promptOnly)
throws RemoteException
report - the specified report.promptOnly - true if only include the user variables that
are declared as 'Prompt User'.
RemoteException
public UserVariable[] getQueryParameters(ReportSheet report,
boolean promptOnly,
int pflag)
throws RemoteException
report - the specified report.promptOnly - true if only include the user variables that
are declared as 'Prompt User'.pflag - the specified parameter flag.
queries and data models.
RemoteException
public UserVariable[] getQueryParameters(ReportSheet report,
boolean promptOnly,
int pflag,
VariableTable nopromptVars)
throws RemoteException
promptOnly - true if only include the user variables that
are declared as 'Prompt User'.pflag - the specified parameter flag.nopromptVars - this table will be populated with the default
value for non-prompting parameters upon return.
RemoteException
public void executeChoiceQuery(UserVariable var,
XQueryRepository rep)
public void executeChoiceQuery(UserVariable var,
XQueryRepository rep,
String ename)
public boolean execute(ReportSheet report)
throws Exception
report - report to execute.
Exception
protected boolean execute(ReportSheet report,
boolean force)
throws Exception
report - report to execute.
Exception
public void execute(ReportSheet report,
VariableTable vars)
throws Exception
report - report to execute.vars - report parameters.
Exception
public void execute(ReportSheet report,
VariableTable vars,
Principal user)
throws Exception
report - report to execute.vars - report parameters.user - a Principal object that identifies the user executing the
query.
Exception
public void execute(ReportSheet report,
VariableTable vars,
Principal user,
String[] qrs)
throws Exception
report - report to execute.vars - report parameters.user - a Principal object that identifies the user executing the
query.qrs - the queries visible to the user executing the report
Exception
public void cancel(ReportSheet report)
throws Exception
Exception
public void destroyReport(ReportSheet report)
throws Exception
Exception
public XQuery prepareQuery(ReportElement elem,
VariableTable vars)
throws Exception
Exception
public XNodeTableLens getXNodeTableLens(XQuery query,
VariableTable qvars,
Principal user)
throws Exception
query - the specified query.qvars - the specified variable table.user - the specified principal.
Exception
public XNodeTableLens getXNodeTableLens(XQuery query,
VariableTable qvars,
Principal user,
XQueryRepository rep,
Hashtable queries)
throws Exception
query - the specified query.qvars - the specified variable table.user - the specified principal.rep - the specified local query repository.queries - the queries
Exception
public XNodeTableLens getXNodeTableLens(XQuery query,
VariableTable qvars,
Principal user,
XQueryRepository rep,
Hashtable queries,
long ts)
throws Exception
query - the specified query.qvars - the specified variable table.user - the specified principal.rep - the specified local query repository.queries - the queries.ts - touch timestamp of data changes.
Exception
public String getQueryVariableName(String qname,
String vname)
qname - the specified query name.vname - the specified variable name.
protected void execute(ReportSheet report,
ReportElement elem,
VariableTable vars,
Vector chart_tables,
Principal user,
String[] qrs,
Hashtable queries)
throws Exception
Exception
protected void execute(inetsoft.report.internal.BindableElement elem,
inetsoft.report.internal.binding.BindingAttr binding,
VariableTable vars,
Principal user,
Hashtable queries)
throws Exception
Exceptionprotected inetsoft.report.internal.binding.BindingAttr getBindingAttr(ReportElement elem)
public void finalize()
finalize in class Objectpublic void clearCache()
public void setCacheData(boolean useCache)
useCache - - true to cache query resultpublic boolean isCacheData()
public void prepareJoinBinding(inetsoft.report.internal.binding.BindingAttr binding,
ReportSheet report)
public TableLens performJoins(TableLens baseTable,
VariableTable vars,
inetsoft.report.internal.binding.BindingAttr binding,
inetsoft.report.internal.BindableElement elem,
Principal user)
throws Exception
Exceptionpublic static void removeQueryInfo(String queryId)
public static List getExecutingQueries()
|
Copyright © 1996-2014 InetSoft Technology Corp. All Rights Reserved. | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||