Class PreviewVariable


  • public class PreviewVariable
    extends XMLRequest
    Preview of an SQL and Backend Variables.
    • 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