Class Help


  • public class Help
    extends Prepared
    This class represents the statement CALL.
    • Field Detail

      • conditions

        private final java.lang.String[] conditions
      • expressions

        private final Expression[] expressions
    • Constructor Detail

      • Help

        public Help​(SessionLocal session,
                    java.lang.String[] conditions)
    • Method Detail

      • queryMeta

        public ResultInterface queryMeta()
        Description copied from class: Prepared
        Get an empty result set containing the meta data.
        Specified by:
        queryMeta in class Prepared
        Returns:
        the result set
      • query

        public ResultInterface query​(long maxrows)
        Description copied from class: Prepared
        Execute the query.
        Overrides:
        query in class Prepared
        Parameters:
        maxrows - the maximum number of rows to return
        Returns:
        the result set
      • stripAnnotationsFromSyntax

        public static java.lang.String stripAnnotationsFromSyntax​(java.lang.String s)
        Strip out the special annotations we use to help build the railroad/BNF diagrams
        Parameters:
        s - to process
        Returns:
        cleaned text
      • processHelpText

        public static java.lang.String processHelpText​(java.lang.String s)
        Sanitize value read from csv file (i.e. help.csv)
        Parameters:
        s - text to process
        Returns:
        text without wrapping quotes and trimmed
      • getTable

        public static java.sql.ResultSet getTable()
                                           throws java.io.IOException
        Returns HELP table.
        Returns:
        HELP table with columns SECTION,TOPIC,SYNTAX,TEXT
        Throws:
        java.io.IOException - on I/O exception
      • isQuery

        public boolean isQuery()
        Description copied from class: Prepared
        Check if this object is a query.
        Overrides:
        isQuery in class Prepared
        Returns:
        true if it is
      • isTransactional

        public boolean isTransactional()
        Description copied from class: Prepared
        Check if this command is transactional. If it is not, then it forces the current transaction to commit.
        Specified by:
        isTransactional in class Prepared
        Returns:
        true if it is
      • isReadOnly

        public boolean isReadOnly()
        Description copied from class: Prepared
        Check if this command is read only.
        Overrides:
        isReadOnly in class Prepared
        Returns:
        true if it is
      • getType

        public int getType()
        Description copied from class: Prepared
        Get the command type as defined in CommandInterface
        Specified by:
        getType in class Prepared
        Returns:
        the statement type