Section (container-search 6.245.70 API)

java.lang.Object
- com.yahoo.component.provider.FreezableClass
- - com.yahoo.search.pagetemplates.model.Section

All Implemented Interfaces:

com.yahoo.component.provider.Freezable, PageElement
```
public class Section
extends com.yahoo.component.provider.FreezableClass
implements PageElement
```
An element of a page template corresponding to a physical area of the layout of the final physical page. Pages are freezable - once frozen calling a setter will cause an IllegalStateException, and returned live collection references are unmodifiable

Author:

bratseth

Field Summary

Fields
Modifier and Type	Field and Description
`private List<PageElement>`	`elements` The elements of this - sources, subsections etc.
`private String`	`id`
`private Layout`	`layout`
`private int`	`max`
`private int`	`min`
`private static AtomicInteger`	`nextId`
`private Sorting`	`order`
`private String`	`region`
`private List<PageElement>`	`renderers` Filtered versions of elements pre-calculated at freeze time
`private List<PageElement>`	`sections` Filtered versions of elements pre-calculated at freeze time
`private List<PageElement>`	`sources` Filtered versions of elements pre-calculated at freeze time

Constructor Summary

Constructors
Constructor and Description

Section()

Section(String id)
Creates a section with an id (or null if no id)

Constructors
Constructor and Description
`Section()`
`Section(String id)` Creates a section with an id (or null if no id)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`accept(PageTemplateVisitor visitor)` Accepts a visitor to this structure
`private List<PageElement>`	`createElementList(Class pageTemplateModelElementClass)`
`List<PageElement>`	`elements()` Returns the elements of this - sources, subsections and presentations and/or choices of these, as a live reference which can be modified to change the content of this (unless this is frozen).
`List<PageElement>`	`elements(Class pageTemplateModelElementClass)` Convenience method which returns the elements and choices of the given type in elements as a read-only list.
`void`	`freeze()`
`String`	`getId()` Returns a unique id of this section within the page.
`Layout`	`getLayout()` Returns the layout identifier describing the kind of layout which should be used by the rendering engine to lay out the content of this section.
`int`	`getMax()` Returns max number of (immediate) elements/sections permissible within this, -1 means unrestricted.
`int`	`getMin()` Returns min number of (immediate) elements/sections desired within this, -1 means unrestricted.
`Sorting`	`getOrder()` Returns the choice of ways to sort immediate children in this, or empty meaning sort by default order (relevance)
`String`	`getRegion()` Returns the identifier telling the layout of the containing section where this section should be placed.
`void`	`setLayout(Layout layout)` Sets the layout.
`void`	`setMax(int max)`
`void`	`setMin(int min)`
`void`	`setOrder(Sorting order)`
`void`	`setRegion(String region)`
`String`	`toString()`

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

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

- Field Detail
  - id
```
private final String id
```
  - layout
```
private Layout layout
```
  - region
```
private String region
```
  - elements
```
private List<PageElement> elements
```
    The elements of this - sources, subsections etc. and/or choices of the same
  - sections
```
private List<PageElement> sections
```
    Filtered versions of elements pre-calculated at freeze time
  - sources
```
private List<PageElement> sources
```
    Filtered versions of elements pre-calculated at freeze time
  - renderers
```
private List<PageElement> renderers
```
    Filtered versions of elements pre-calculated at freeze time
  - max
```
private int max
```
  - min
```
private int min
```
  - order
```
private Sorting order
```
  - nextId
```
private static AtomicInteger nextId
```
- Constructor Detail
  - Section
```
public Section()
```
  - Section
```
public Section(String id)
```
    Creates a section with an id (or null if no id)
- Method Detail
  - getId
```
public String getId()
```
    Returns a unique id of this section within the page. Used for referencing and identification. Never null.
  - getLayout
```
public Layout getLayout()
```
    Returns the layout identifier describing the kind of layout which should be used by the rendering engine to lay out the content of this section. This is never null. Default: "column".
  - setLayout
```
public void setLayout(Layout layout)
```
    Sets the layout. If the layout is set to null it will become Layout.column
  - getRegion
```
public String getRegion()
```
    Returns the identifier telling the layout of the containing section where this section should be placed. Permissible values, and whether this is mandatory is determined by the particular layout identifier of the parent. May be null if a placement is not required by the containing layout, or if this is the top-level section. This is null by default.
  - setRegion
```
public void setRegion(String region)
```
  - elements
```
public List<PageElement> elements()
```
    Returns the elements of this - sources, subsections and presentations and/or choices of these, as a live reference which can be modified to change the content of this (unless this is frozen).
    All elements are kept in a single list to allow multiple elements of each type to be nested within separate choices, and to maintain the internal order of elements of various types, which is sometimes significant. To extract a certain kind of elements (say, sources), the element list must be traversed to collect all source elements as well as all choices of sources.
    This list is never null but may be empty.
  - elements
```
public List<PageElement> elements(Class pageTemplateModelElementClass)
```
    Convenience method which returns the elements and choices of the given type in elements as a read-only list. Not that as this returns both concrete elements and choices betwen them, the list element cannot be case to the given class - this must be used in conjunction with a resolve which contains the resolution to the choices.
    
    Parameters:
    
    pageTemplateModelElementClass - type to returns elements and choices of, a subtype of PageElement
  - createElementList
```
private List<PageElement> createElementList(Class pageTemplateModelElementClass)
```
  - getOrder
```
public Sorting getOrder()
```
    Returns the choice of ways to sort immediate children in this, or empty meaning sort by default order (relevance)
  - setOrder
```
public void setOrder(Sorting order)
```
  - getMax
```
public int getMax()
```
    Returns max number of (immediate) elements/sections permissible within this, -1 means unrestricted. Default: -1.
  - setMax
```
public void setMax(int max)
```
  - getMin
```
public int getMin()
```
    Returns min number of (immediate) elements/sections desired within this, -1 means unrestricted. Default: -1.
  - setMin
```
public void setMin(int min)
```
  - freeze
```
public void freeze()
```
    Specified by:
    
    freeze in interface com.yahoo.component.provider.Freezable
    
    Overrides:
    
    freeze in class com.yahoo.component.provider.FreezableClass
  - 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 Object

Class Section

Field Summary

Constructor Summary

Method Summary

Methods inherited from class com.yahoo.component.provider.FreezableClass

Methods inherited from class java.lang.Object

Methods inherited from interface com.yahoo.component.provider.Freezable

Field Detail

id

layout

region

elements

sections

sources

renderers

max

min

order

nextId

Constructor Detail

Section

Section

Method Detail

getId

getLayout

setLayout

getRegion

setRegion

elements

elements

createElementList

getOrder

setOrder

getMax

setMax

getMin

setMin

freeze

accept

toString