Class PageTemplate

  • All Implemented Interfaces:,, PageElement, java.lang.Comparable<>

    public final class PageTemplate
    implements PageElement
    A page template represents a particular way to organize a result page. It is a recursive structure of page template elements.
    • Field Summary

      • Fields inherited from class

    • Constructor Summary

      Constructor Description
      PageTemplate​( id)  
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void accept​(PageTemplateVisitor visitor)
      Accepts a visitor to this structure
      void freeze()  
      Section getSection()
      Returns the root section of this.
      java.util.Set<Source> getSources()
      Returns an unmodifiable set of all the sources this template may include (depending on choice resolution).
      void setSection​(Section section)  
      java.lang.String toString()  
      • Methods inherited from class

        clone, ensureNotFrozen, isFrozen
      • Methods inherited from class

        compareTo, deconstruct, getClassName, getId, getIdString, hasInitializedId, initId, isDeconstructable, setIsDeconstructable
      • Methods inherited from class java.lang.Object

        equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
      • Methods inherited from interface

    • Constructor Detail

      • PageTemplate

        public PageTemplate​( id)
    • Method Detail

      • setSection

        public void setSection​(Section section)
      • getSection

        public Section getSection()
        Returns the root section of this. This is never null.
      • getSources

        public java.util.Set<Source> getSources()
        Returns an unmodifiable set of all the sources this template may include (depending on choice resolution). If the template allows (somewhere) the "any" source (*), Source.any will be in the set returned. This operation is fast on frozen page templates (i.e at execution time).
      • freeze

        public void freeze()
        Specified by:
        freeze in interface
        freeze in class
      • toString

        public java.lang.String toString()
        toString in class