Class BasicFilter

    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      protected BasicFilter​(java.lang.String name, java.lang.String usage)
      Constructor.
    • Constructor Detail

      • BasicFilter

        protected BasicFilter​(java.lang.String name,
                              java.lang.String usage)
        Constructor.
        Parameters:
        name - filter name
        usage - filter usage
    • Method Detail

      • getName

        public java.lang.String getName()
      • getUsage

        public java.lang.String getUsage()
        Description copied from interface: ProcessingFilter
        Usage message for this filter. This should contain any arguments which apply to this item; the name itself should not be included. May contain newline characters to break up a long line.
        Specified by:
        getUsage in interface ProcessingFilter
        Returns:
        usage string
      • getDescription

        public java.lang.String getDescription()
        Description copied from interface: ProcessingFilter
        Description for this filter. This is currently inserted into the user document, so should be in XML format.
        Specified by:
        getDescription in interface ProcessingFilter
        Returns:
        textual description of this filter
      • getDescriptionLines

        protected abstract java.lang.String[] getDescriptionLines()
      • explainSyntax

        public static java.lang.String explainSyntax​(java.lang.String[] usages)
        Returns a snippet of XML explaining use of the syntax of some given usage-type example arguments. These may be one of the following:
        • expr
        • col-id
        • colid-list
        either alone or with some other text pre- or ap-pended.
        Parameters:
        usages - array of formal arguments to be explained
        Returns:
        XML explanation