Class AbstractLayoutSource

  • All Implemented Interfaces:
    Direct Known Subclasses:
    LayoutSourceFile, LayoutSourceString

    public abstract class AbstractLayoutSource
    extends java.lang.Object
    implements LayoutSource
    This abstract base class manages caching of Layout definitions and provides a simple implementation of LayoutParser.MessageListener
    MicroStrategy Web 8.0.0
    • Constructor Detail

      • AbstractLayoutSource

        public AbstractLayoutSource()
    • Method Detail

      • getLayoutString

        protected abstract java.lang.String getLayoutString​(java.lang.String location)
                                                     throws WebTransformException
        Returns the string representation of a layout definition. The layout cache uses this method to load the layout definition string and then delegates to the layout parser to parse it. The parsed layou definition is cached.
        location - the layout location, defined in the StyleCatalog XML file.
        the string representation of a layout definition.
        WebTransformException - if there is any error while retrieving the layout string
      • checkNullObject

        protected void checkNullObject​(java.lang.Object o,
                                       java.lang.String msg)
        A utility method to check whether an object is null. IllegalArgumentException is thrown if the object is null.
        o - the object to check
        msg - the error message used to report error