|
Style Intelligence v12.0 | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectinetsoft.uql.VariableTable
public class VariableTable
The VariableTable holds the variable values. It is passed to the query engine during query execution. The variable table should be populated for every variable in the query that require user supplied values. The inetsoft.uql.builder.VariableEntry class can be used to interactively prompt users for the values.
| Field Summary | |
|---|---|
static String |
HTTP_REQUEST
Deprecated. use SERVICE_REQUEST. |
static String |
HTTP_RESPONSE
Deprecated. use SERVICE_RESPONSE. |
static String |
SERVICE_REQUEST
The name for the ServiceRequest parameter. |
static String |
SERVICE_RESPONSE
The name for the ServiceResponse parameter. |
| Constructor Summary | |
|---|---|
VariableTable()
Constructor. |
|
| Method Summary | |
|---|---|
void |
addAll(VariableTable vars)
Add all variables. |
void |
addBaseTable(VariableTable table)
Add a table to the chain as the lowest priority table. |
void |
clear()
Remove all entries. |
Object |
clone()
Clone. |
boolean |
contains(String name)
Check if the variable is inside this table. |
void |
copyParameters(XPrincipal user)
Copy the parameters set in user principal. |
boolean |
equals(Object obj)
Check if equals another object. |
boolean |
equalsContent(Object obj)
Check if equals another object in content. |
Object |
get(String name)
Get the value of a variable. |
Object |
get(UserVariable var)
Get the value of a variable. |
VariableTable |
getBaseTable()
Get the base variable table. |
Object |
getSession()
Get the session associated with this table. |
VariableTable |
getSubset(String prefix)
Get a variable table containing only the variables with the specified prefix. |
int |
hashCode()
Get the hash code value. |
static boolean |
isBuiltinVariable(String name)
Check if a variable is builtin. |
static boolean |
isContextVariable(String name)
Check if a variable is context variable, which does not require prompt, for its value will be fetch from context. |
boolean |
isInternalParameter(String name)
Check if is internal parameter. |
Enumeration |
keys()
Get all variable names in the table. |
boolean |
printKey(PrintWriter writer)
Create a unique key to identify this variable table. |
void |
put(String name,
Object value)
Set a variable value. |
void |
remove(String name)
Remove a variable from the table. |
void |
removeBaseTable(Class type)
Remove tables matching the type from the base table chain. |
void |
removeBaseTable(VariableTable table)
Remove a table from the base table chain. |
void |
setBaseTable(VariableTable table)
Set the base table for this variable table. |
void |
setSession(Object session)
This method is called by the server to associate a table with an user session. |
int |
size()
Return the number of variables in the table. |
String |
toString()
To string. |
| Methods inherited from class java.lang.Object |
|---|
finalize, getClass, notify, notifyAll, wait, wait, wait |
| Field Detail |
|---|
public static final String HTTP_REQUEST
public static final String HTTP_RESPONSE
public static final String SERVICE_REQUEST
ServiceRequest,
Constant Field Valuespublic static final String SERVICE_RESPONSE
ServiceResponse,
Constant Field Values| Constructor Detail |
|---|
public VariableTable()
| Method Detail |
|---|
public static boolean isContextVariable(String name)
public void setSession(Object session)
public Object getSession()
public void copyParameters(XPrincipal user)
public void setBaseTable(VariableTable table)
table - base variable table.public VariableTable getBaseTable()
public void addBaseTable(VariableTable table)
public void removeBaseTable(VariableTable table)
public void removeBaseTable(Class type)
public int size()
public void addAll(VariableTable vars)
throws Exception
Exception
public void put(String name,
Object value)
name - variable name.value - variable value.public void clear()
public boolean contains(String name)
public Object get(UserVariable var)
throws Exception
var - UserVariable object.
Exception
public Object get(String name)
throws Exception
name - variable name.
Exceptionpublic void remove(String name)
name - variable name.public Enumeration keys()
public VariableTable getSubset(String prefix)
public static boolean isBuiltinVariable(String name)
public Object clone()
clone in class Objectpublic String toString()
toString in class Object
public boolean printKey(PrintWriter writer)
throws Exception
printKey in interface inetsoft.util.ContentObjectExceptionpublic boolean equalsContent(Object obj)
equalsContent in interface inetsoft.util.ContentObjectpublic boolean equals(Object obj)
equals in class Objectobj - the specified object.
public int hashCode()
hashCode in class Objectpublic boolean isInternalParameter(String name)
|
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 | ||||||||