Interface LayoutParserDefn

  • All Superinterfaces:
    java.lang.Cloneable, ConfigurationElement
    All Known Implementing Classes:

    public interface LayoutParserDefn
    extends ConfigurationElement
    The LayoutParserDefn interface stores the definition of a LayoutParser by recording a unique name and a fully qualified class name. This interface also provides a method to get an instance of the specified parser. Note that only a single instance of the parser is given out--it must be thread safe and not store any instance data members.
    MicroStrategy Web 8.0.0
    • Method Detail

      • getName

        java.lang.String getName()
        Gets the name associated with this layout parser.
        The name of the layout parser.
      • setName

        void setName​(java.lang.String name)
              throws java.lang.IllegalArgumentException
        Sets the name of the layout parser. The name is used in other places where a layout parser is required.
        name - The name of the layout parser.
        java.lang.IllegalArgumentException - If the name is already used, then this exception is thrown.
      • getImplClassName

        java.lang.String getImplClassName()
        Gets the fully qualified class name for the layout parser.
        The fully qualified class name for the layout parser.
      • setImplClassName

        void setImplClassName​(java.lang.String fqcn)
        Sets the fully qualified class name for the layout parser.
        fqcn - The fully qualified class name.
      • getLayoutParserInstance

        LayoutParser getLayoutParserInstance()
        Creates or returns an existing instance of the referred layout parser.
        An instance of the layout parser object.