Package com.uc4.communication.requests

Class PreviewVariable

java.lang.Object

com.uc4.communication.requests.XMLRequest

com.uc4.communication.requests.PreviewVariable

public class PreviewVariable
extends XMLRequest

Preview of an SQL and Backend Variables.

Constructor Summary

Constructors

Constructor	Description
PreviewVariable(Variable var)	Creates a new Preview Request for SQL Variables.
PreviewVariable(UC4ObjectName name)	Creates a new Preview Request for dynamic Variables.

Method Summary

Modifier and Type	Method	Description
protected void	createRequest(com.uc4.util.XMLDocument doc, org.w3c.dom.Element request, ConnectionAttributes sessionInfo)	Creates the XML Document for the request.
java.lang.String[]	getColumnNames()	Returns a String array which contains the names of the columns.
java.lang.String[]	getRow(int index)	Returns the data of the specified row.
protected java.lang.String	getSrc()	Returns the request source.
java.lang.String	getSubType()	Returns the type of the variable.
protected void	handleContent(com.uc4.util.XMLDocument doc, ConnectionAttributes session)	Sub classes extract the values from the XML document and provide public getter methods.
protected boolean	isAllowedInClientZero()	This method is used internally.
int	size()	Returns the number of data rows in the preview.

Methods inherited from class com.uc4.communication.requests.XMLRequest

assertClientZero, assertServerVersion, checkClient, checkID, checkLnr, checkNull, checkSelStatisticsPrivilege, checkSystemOverviewPrivilege, checkUC4ObjectEmptyName, checkUC4ObjectName, createNATFor, createNATRequest, emptyAttributes, getAllMessageBoxes, getMessageBox, getRequestID, handleResponse, ignoreMessageBox, send, setMessageBox, showQuarantineNotification

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PreviewVariable

public PreviewVariable(Variable var)

Creates a new Preview Request for SQL Variables.

Parameters:

var - Internal or external SQL Variable

PreviewVariable

public PreviewVariable(UC4ObjectName name)

Creates a new Preview Request for dynamic Variables.

Parameters:

name - Name of the variable object

Method Detail

getSrc

protected java.lang.String getSrc()

Description copied from class: XMLRequest

Returns the request source. This method is used internally.

Specified by:

getSrc in class XMLRequest

Returns:

Source

createRequest

protected void createRequest(com.uc4.util.XMLDocument doc,
                             org.w3c.dom.Element request,
                             ConnectionAttributes sessionInfo)

Description copied from class: XMLRequest

Creates the XML Document for the request. This method is used internally.

Specified by:

createRequest in class XMLRequest

Parameters:

doc - Document, used to create new Elements

request - Request Element - classes append information to this request element

sessionInfo - Information about the session

handleContent

protected void handleContent(com.uc4.util.XMLDocument doc,
                             ConnectionAttributes session)

Description copied from class: XMLRequest

Sub classes extract the values from the XML document and provide public getter methods.

Overrides:

handleContent in class XMLRequest

Parameters:

doc - XML Document

session - Info about the user session

getSubType

public java.lang.String getSubType()

Returns the type of the variable.

Returns:

For example SQLI_SEC or an empty String if this information is not available

Since:

V12

size

public int size()

Returns the number of data rows in the preview.

Returns:

Number of rows

getRow

public java.lang.String[] getRow(int index)

Returns the data of the specified row.

Parameters:

index - Index, 0 to size() -1

Returns:

String array containing the data

getColumnNames

public java.lang.String[] getColumnNames()

Returns a String array which contains the names of the columns.

Returns:

Column names

isAllowedInClientZero

protected boolean isAllowedInClientZero()

Description copied from class: XMLRequest

This method is used internally. Tests if this XMLRequest is allowed in client 0. The default implementation returns false, subclasses may override.

Overrides:

isAllowedInClientZero in class XMLRequest

Returns:

true if this request is allowed in client 0, false otherwise