Style Intelligence v12.0

inetsoft.uql.text
Class TextQuery

java.lang.Object
  extended by inetsoft.uql.XQuery
      extended by inetsoft.uql.text.TextQuery
All Implemented Interfaces:
inetsoft.util.XMLSerializable, Serializable, Cloneable

public class TextQuery
extends XQuery

Text data query.

See Also:
Serialized Form

Field Summary
 
Fields inherited from class inetsoft.uql.XQuery
DERIVED, HINT_DEFAULT_MAX_ROWS, HINT_IGNORE_MAX_ROWS, HINT_MAX_ROWS, HINT_TIMEOUT
 
Constructor Summary
TextQuery()
          Create a text query object.
 
Method Summary
 Object clone()
          Create a clone of this object.
protected  void findVariables(Map varmap)
          Find all variables used in this query.
 int getColNum()
          Deprecated. 
 inetsoft.uql.jdbc.XFilterNode getCondition()
          Get the condition.
 String getDelimiter()
          Get the delimiters used in the text data file.
 inetsoft.uql.text.TextFileType getFileType()
          Get file type.
 int[] getFixedLengths()
          Get the length of each column.
 XTypeNode getOutputType(Object session, boolean full)
          Get the output type of the query.
 String getRequest()
          Get the request name for this query.
 XNode getRequestParameters()
          Get the parameters defined in the data source for this type of queries.
 int[] getSelectedCols()
          Get the selected (shown) column indices.
 XSelection getSelection()
          Get the XSelection object.
 XSelection getTableSpec()
          Get the table column specification.
 boolean isDistinct()
          Get whether the query result is distinct.
 boolean isFirstHeaderRow()
          Check if the first row should be treated as a header row.
 boolean isLengthFixed()
          Deprecated. 
 void parseXML(Element root)
          Parse the XML element that contains information on this query.
 void setCondition(inetsoft.uql.jdbc.XFilterNode conditionNode)
          Set the condition.
 void setDistinct(boolean distinct)
          Set the query result distinct.
 void setFirstHeaderRow(boolean isHeaderRow)
          Deprecated. 5.1
 void setRequest(String method)
          Set the request name for this query.
 void setSelectedCols(int[] cols)
          Set the selected columns.
 void setTableSpec(XSelection tablespec)
          Set the table column specification.
 void writeXML(PrintWriter writer)
          Generate the XML segment to represent this query.
 
Methods inherited from class inetsoft.uql.XQuery
addVariable, equals, findVariables, findVariables, findVariables, findVariables, getAllDefinedVariables, getDataSource, getDefinedVariables, getDescription, getEstimatedTime, getFolder, getMaxRows, getName, getOutputType, getPartition, getProperty, getTimeout, getType, getVariable, getVariableNames, hashCode, isOutputTypeAvailable, isVisible, removeVariable, revalidate, setDataSource, setDescription, setEstimatedTime, setFolder, setMaxRows, setName, setPartition, setProperty, setTimeout, setVisible, toString, updateQueryVariable
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

TextQuery

public TextQuery()
Create a text query object.

Method Detail

getRequestParameters

public XNode getRequestParameters()
Get the parameters defined in the data source for this type of queries.


findVariables

protected void findVariables(Map varmap)
Find all variables used in this query.

Overrides:
findVariables in class XQuery

setRequest

public void setRequest(String method)
Set the request name for this query. The request name is one of the requests defined in the corresponding data source.


getRequest

public String getRequest()
Get the request name for this query.


setDistinct

public void setDistinct(boolean distinct)
Set the query result distinct.


isDistinct

public boolean isDistinct()
Get whether the query result is distinct.


getDelimiter

public String getDelimiter()
Get the delimiters used in the text data file.


isFirstHeaderRow

public boolean isFirstHeaderRow()
Check if the first row should be treated as a header row.


setFirstHeaderRow

@Deprecated
public void setFirstHeaderRow(boolean isHeaderRow)
Deprecated. 5.1

Set the first row as header.


isLengthFixed

@Deprecated
public boolean isLengthFixed()
Deprecated. 

Check if the column length is fixed.


getFixedLengths

public int[] getFixedLengths()
Get the length of each column.


getColNum

@Deprecated
public int getColNum()
Deprecated. 

Get the column number(Only if the text datasource is fixed length, else return -1).


getOutputType

public XTypeNode getOutputType(Object session,
                               boolean full)
Get the output type of the query. The return value is either the root of a subtree of the a type tree, or a one level tree with each child representing a table column.

Specified by:
getOutputType in class XQuery
Parameters:
session - the session object
full - true to fetch full name

getSelection

public XSelection getSelection()
Get the XSelection object.

Specified by:
getSelection in class XQuery

getTableSpec

public XSelection getTableSpec()
Get the table column specification.


setTableSpec

public void setTableSpec(XSelection tablespec)
Set the table column specification.


getSelectedCols

public int[] getSelectedCols()
Get the selected (shown) column indices.


setSelectedCols

public void setSelectedCols(int[] cols)
Set the selected columns.


parseXML

public void parseXML(Element root)
              throws Exception
Parse the XML element that contains information on this query.

Specified by:
parseXML in interface inetsoft.util.XMLSerializable
Overrides:
parseXML in class XQuery
Throws:
Exception

writeXML

public void writeXML(PrintWriter writer)
Generate the XML segment to represent this query.

Specified by:
writeXML in interface inetsoft.util.XMLSerializable
Overrides:
writeXML in class XQuery

getFileType

public inetsoft.uql.text.TextFileType getFileType()
Get file type.


clone

public Object clone()
Create a clone of this object.

Overrides:
clone in class XQuery

getCondition

public inetsoft.uql.jdbc.XFilterNode getCondition()
Get the condition.


setCondition

public void setCondition(inetsoft.uql.jdbc.XFilterNode conditionNode)
Set the condition.


Copyright © 1996-2014 InetSoft Technology Corp. All Rights Reserved.