|
Style Intelligence v12.0 | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectinetsoft.uql.XQuery
public abstract class XQuery
XQuery object represents a query in the query registry. Each query must have an unique name in a registry.
| Field Summary | |
|---|---|
static String |
DERIVED
A derived query type. |
static String |
HINT_DEFAULT_MAX_ROWS
A hint indicates that the max rows is the default value defined internally. |
static String |
HINT_IGNORE_MAX_ROWS
A hint indicates that the max rows definition should be ignored. |
static String |
HINT_MAX_ROWS
A hint to change the query max rows setting. |
static String |
HINT_TIMEOUT
A hint to change the query timeout setting. |
| Constructor Summary | |
|---|---|
protected |
XQuery(String type)
Create a query object with the specified type. |
| Method Summary | |
|---|---|
void |
addVariable(XVariable var)
Add a variable to this query. |
Object |
clone()
Create a clone of this object. |
boolean |
equals(Object obj)
Check if equals another object. |
protected void |
findVariables(Map varmap)
Find all variables used in this query. |
protected void |
findVariables(inetsoft.uql.jdbc.XExpression expression,
Map varmap)
Find all variables in the string and add to the variable list. |
void |
findVariables(XNode root)
|
protected void |
findVariables(XNode root,
Map varmap)
Find all variables in the value tree and add to the variable list. |
protected void |
findVariables(XNodePath path)
Find all variables in the path and add to the variable list. |
Enumeration |
getAllDefinedVariables()
Get the names of all variables need to be defined in this query, include all variables, such as build in variable. |
XDataSource |
getDataSource()
Get the data source this query is associated with. |
Enumeration |
getDefinedVariables()
Get the names of all variables need to be defined in this query. |
String |
getDescription()
Get the description of this data source. |
long |
getEstimatedTime()
Get the estimated occupied time. |
String |
getFolder()
Get the query folder. |
int |
getMaxRows()
Get the row limit (maximum number of rows) of this query. |
String |
getName()
Get the query name. |
XTypeNode |
getOutputType(Object session)
Get the output type of the query. |
abstract XTypeNode |
getOutputType(Object session,
boolean full)
Get the output type of the query. |
String |
getPartition()
Gets the name of the partition used to apply VPM conditions to this query. |
Object |
getProperty(String name)
Get a property value. |
abstract XSelection |
getSelection()
Get the XSelection object. |
int |
getTimeout()
Get query timeout value in seconds. |
String |
getType()
Get the query type. |
XVariable |
getVariable(String name)
Get a variable defined in this query. |
Enumeration |
getVariableNames()
Get the names of all variables used in this query. |
int |
hashCode()
Get the hash code value. |
boolean |
isOutputTypeAvailable()
Check if is output type of the query is available. |
boolean |
isVisible()
Check if this query is visible to end user. |
void |
parseXML(Element root)
Parse the XML element that contains information on this query. |
void |
removeVariable(String name)
Remove a variable from this query. |
void |
revalidate()
Revalidate the query object if context changes, for example, data source registry changes. |
void |
setDataSource(XDataSource datasource)
Set the data source this query is associated with. |
void |
setDescription(String desc)
Set the description of this data source. |
void |
setEstimatedTime(long estimated)
Set the estimated occupied time. |
void |
setFolder(String folder)
Set the query folder. |
void |
setMaxRows(int rowlimit)
Set the row limit (maximum number of rows) of this query. |
void |
setName(String name)
Set the query name. |
void |
setPartition(String partition)
Sets the name of the partition used to apply VPM conditions to this query. |
void |
setProperty(String name,
Object val)
Set a property value. |
void |
setTimeout(int seconds)
Set query timeout value in seconds. |
void |
setVisible(boolean vis)
Set if this query should be visible to end user (composer). |
String |
toString()
Get the string representation. |
void |
updateQueryVariable(XQueryRepository repository)
Update the query to set the local query repository to the query variable, so that the local query can be found at runtime. |
void |
writeXML(PrintWriter writer)
Generate the XML segment to represent this query. |
| Methods inherited from class java.lang.Object |
|---|
finalize, getClass, notify, notifyAll, wait, wait, wait |
| Field Detail |
|---|
public static final String HINT_MAX_ROWS
public static final String HINT_TIMEOUT
public static final String HINT_DEFAULT_MAX_ROWS
public static final String DERIVED
public static final String HINT_IGNORE_MAX_ROWS
| Constructor Detail |
|---|
protected XQuery(String type)
type - data source type. One of values defined in XDataSource.| Method Detail |
|---|
public void setName(String name)
public String getName()
public void setFolder(String folder)
public String getFolder()
public String getType()
public void setDataSource(XDataSource datasource)
public XDataSource getDataSource()
public abstract XTypeNode getOutputType(Object session,
boolean full)
session - the session objectfull - true to fetch full namepublic boolean isOutputTypeAvailable()
public XTypeNode getOutputType(Object session)
session - the session objectpublic Enumeration getDefinedVariables()
public Enumeration getAllDefinedVariables()
public Enumeration getVariableNames()
public XVariable getVariable(String name)
name - variable name.
public void addVariable(XVariable var)
var - variable definition.public void removeVariable(String name)
name - variable name.public void setDescription(String desc)
public String getDescription()
public long getEstimatedTime()
public void setEstimatedTime(long estimated)
estimated - the estimated occupied time.public void setMaxRows(int rowlimit)
public int getMaxRows()
public void setTimeout(int seconds)
public int getTimeout()
public void setVisible(boolean vis)
public boolean isVisible()
public String getPartition()
null if no VPM
conditions should be applied.public void setPartition(String partition)
partition - the name of a partition or null if no VPM
conditions should be applied.public void revalidate()
public void setProperty(String name,
Object val)
public Object getProperty(String name)
public abstract XSelection getSelection()
public void parseXML(Element root)
throws Exception
parseXML in interface inetsoft.util.XMLSerializableExceptionpublic void writeXML(PrintWriter writer)
writeXML in interface inetsoft.util.XMLSerializableprotected void findVariables(Map varmap)
public void findVariables(XNode root)
protected void findVariables(XNode root,
Map varmap)
protected void findVariables(inetsoft.uql.jdbc.XExpression expression,
Map varmap)
protected void findVariables(XNodePath path)
public void updateQueryVariable(XQueryRepository repository)
public Object clone()
clone in class Objectpublic int hashCode()
hashCode in class Objectpublic boolean equals(Object obj)
equals in class Objectpublic String toString()
toString in class Object
|
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 | ||||||||