PageTemplate (container-search 7.551.16 API)

java.lang.Object
- com.yahoo.component.AbstractComponent
- - com.yahoo.component.provider.FreezableComponent
  - - com.yahoo.search.pagetemplates.PageTemplate

All Implemented Interfaces:

com.yahoo.component.Component, com.yahoo.component.Deconstructable, com.yahoo.component.provider.Freezable, PageElement, Comparable<com.yahoo.component.Component>
```
public final class PageTemplate
extends com.yahoo.component.provider.FreezableComponent
implements PageElement
```
A page template represents a particular way to organize a result page. It is a recursive structure of page template elements.

Author:

bratseth

Field Summary
- Fields inherited from class com.yahoo.component.AbstractComponent
  isDeconstructable

Constructor Summary

Constructors
Constructor Description

PageTemplate(com.yahoo.component.ComponentId 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.
`Set<Source>`	`getSources()`	Returns an unmodifiable set of all the sources this template may include (depending on choice resolution).
`void`	`setSection(Section section)`
`String`	`toString()`

Methods inherited from class com.yahoo.component.provider.FreezableComponent
clone, ensureNotFrozen, isFrozen

Methods inherited from class com.yahoo.component.AbstractComponent
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 com.yahoo.component.provider.Freezable
isFrozen

- Constructor Detail
  - PageTemplate
```
public PageTemplate(com.yahoo.component.ComponentId 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 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 com.yahoo.component.provider.Freezable
    
    Overrides:
    
    freeze in class com.yahoo.component.provider.FreezableComponent
  - accept
```
public void accept(PageTemplateVisitor visitor)
```
    Accepts a visitor to this structure
    
    Specified by:
    
    accept in interface PageElement
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class com.yahoo.component.AbstractComponent