|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.ibm.etools.sqltoxml.BaseProperties | +--com.ibm.etools.sqltoxml.QueryProperties
This class provides information necessary for SQLToXML to perform its SQL query and generate an XML file as well as several other artifacts. The information can be either set manually or loaded from a query file (which usually has an extension .xst). Also, the information can be stored to a query file.
SQLToXML
Constructor Summary | |
QueryProperties()
The default constructor. |
Method Summary | |
java.lang.String |
getFormat()
Returns a format option. |
boolean |
getRecurse()
Returns a boolean value indicating whether or not the queries should also be performed on the target tables when foreign key columns from the current query are found. |
java.lang.String |
getStatement()
Returns current SQL statement to be executed. |
java.util.Vector |
getVarTypes()
Deprecated. Returns a sequence of substitution parameter types. VarTypes are used when a SQL statement contains substitution parameters, such as '?', and the user wants to indicate the data types for those parameters explicitly. |
void |
load(java.io.InputStream stream)
Loads necessary query values from an InputStream. |
void |
load(java.lang.String xstFilename)
Loads necessary query values from a query file. |
void |
setFormat(java.lang.String newFormat)
Sets a format option. |
void |
setRecurse(boolean newRecurse)
Sets a boolean value indicating whether or not the queries should also be performed on the target tables when foreign key columns from the current query are found. |
void |
setStatement(java.lang.String newStatement)
Sets current SQL statement. |
void |
setVarTypes(java.util.Vector types)
Deprecated. VarTypes are used when a SQL statement contains substitution parameters, such as '?', and the user wants to indicate the data types for those parameters explicitly. |
void |
store(java.lang.String xstFilename)
Stores necessary query values to a query file. |
Methods inherited from class com.ibm.etools.sqltoxml.BaseProperties |
getEncoding, getEncodingTag, getJdbcDriver, getJdbcServer, getLoginId, getPassword, setEncoding, setEncodingTag, setJdbcDriver, setJdbcServer, setLoginId, setPassword |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public QueryProperties()
Method Detail |
public void load(java.lang.String xstFilename) throws java.lang.Exception
load
in class BaseProperties
xstFilename
- The name of the query file.java.lang.Exception
- Thrown when loading from a file fails.public void load(java.io.InputStream stream) throws java.lang.Exception
load
in class BaseProperties
stream
- java.io.InputStream Provides query information in XML format.java.lang.Exception
- Thrown when loading from an InputStream is
failed.public void store(java.lang.String xstFilename) throws java.lang.Exception
store
in class BaseProperties
xstFilename
- The name of the query file to be createdjava.lang.Exception
- Thrown when storing to a file is failed.public java.lang.String getFormat()
SQLGenerateOptions.GENERATE_AS_ELEMENTS, SQLGenerateOptions.GENERATE_AS_ATTRIBUTES, SQLGenerateOptions.GENERATE_PRIMARYKEYS_AS_ATTRIBUTES, and SQLGenerateOptions.GENERATE_ID_AND_IDREF
public boolean getRecurse()
public java.lang.String getStatement()
public java.util.Vector getVarTypes()
public void setFormat(java.lang.String newFormat)
GENERATE_AS_ELEMENTS, GENERATE_AS_ATTRIBUTES, GENERATE_PRIMARYKEYS_AS_ATTRIBUTES, and GENERATE_ID_AND_IDREF
newFormat
- A format option for the query result.public void setRecurse(boolean newRecurse)
newRecurse
- A boolean value to determine whether or not new queries
should be performed for the foreign key columns.public void setStatement(java.lang.String newStatement)
newStatement
- A SQL statement.public void setVarTypes(java.util.Vector types)
types
- A Vector containing data types for substitution parameters.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |