Uses of Interface
com.yahoo.search.pagetemplates.model.PageElement

Packages that use PageElement

Package	Description
com.yahoo.search.pagetemplates
com.yahoo.search.pagetemplates.config
com.yahoo.search.pagetemplates.engine
com.yahoo.search.pagetemplates.model

Uses of PageElement in com.yahoo.search.pagetemplates

Classes in com.yahoo.search.pagetemplates that implement PageElement

Modifier and Type	Class and Description
class	PageTemplate A page template represents a particular way to organize a return page.

Methods in com.yahoo.search.pagetemplates that return types with arguments of type PageElement

Modifier and Type	Method and Description
private List<PageElement>	PageTemplateSearcher.selectPageTemplates(Query query) Returns the list of page templates specified in the query, or the default if none, or the empty list if no default, never null.

Method parameters in com.yahoo.search.pagetemplates with type arguments of type PageElement

Modifier and Type	Method and Description
private void	PageTemplateSearcher.addErrorIfSameSourceMultipleTimes(List<PageElement> pages, Set<Source> sources, Query query) Currently executing multiple queries to the same source with different parameter sets, is not supported.
private void	PageTemplateSearcher.addSources(List<PageElement> pages, Query query) Sets query.getModel().getSources() to the right value and add source parameters specified in templates

Uses of PageElement in com.yahoo.search.pagetemplates.config

Methods in com.yahoo.search.pagetemplates.config that return PageElement

Modifier and Type	Method and Description
private PageElement	PageTemplateXMLReader.readPageElement(Element child) Returns the page element corresponding to the given node, never null

Methods in com.yahoo.search.pagetemplates.config that return types with arguments of type PageElement

Modifier and Type	Method and Description
private List<PageElement>	PageTemplateXMLReader.readInclude(Element element) Reads the direct descendant elements of an include
private List<PageElement>	PageTemplateXMLReader.readPageElements(Element parent) Returns all page elements found under the given node

Methods in com.yahoo.search.pagetemplates.config with parameters of type PageElement

Modifier and Type	Method and Description
private void	PageTemplateXMLReader.addIfNonNull(PageElement pageElement, List<PageElement> pageElements)

Method parameters in com.yahoo.search.pagetemplates.config with type arguments of type PageElement

Modifier and Type	Method and Description
private void	PageTemplateXMLReader.addIfNonNull(PageElement pageElement, List<PageElement> pageElements)

Uses of PageElement in com.yahoo.search.pagetemplates.engine

Fields in com.yahoo.search.pagetemplates.engine with type parameters of type PageElement

Modifier and Type	Field and Description
private Map<MapChoice,Map<String,List<PageElement>>>	Resolution.mapChoiceResolutions A of map choices made as choice → mapping

Methods in com.yahoo.search.pagetemplates.engine that return types with arguments of type PageElement

Modifier and Type	Method and Description
Map<String,List<PageElement>>	Resolution.getResolution(MapChoice choice) Returns the resolution of a map choice.

Method parameters in com.yahoo.search.pagetemplates.engine with type arguments of type PageElement

Modifier and Type	Method and Description
void	Resolution.addMapChoiceResolution(MapChoice choice, Map<String,List<PageElement>> mapping)
private void	Organizer.renderElements(Resolution resolution, Result result, SectionHitGroup sectionGroup, List<String> sourceList, List<PageElement> elements)

Uses of PageElement in com.yahoo.search.pagetemplates.model

Classes in com.yahoo.search.pagetemplates.model that implement PageElement

Modifier and Type	Class and Description
class	AbstractChoice Abstract superclass of various kinds of choices.
class	Choice A choice between some alternative lists of page elements.
class	MapChoice A choice between different possible mapping functions of a set of values to a set of placeholder ids.
class	Placeholder A source placeholder is replaced with a list of source instances at evaluation time.
class	Renderer A description of a way to present data items from a source.
class	Section An element of a page template corresponding to a physical area of the layout of the final physical page.
class	Source A source mentioned in a page template.

Fields in com.yahoo.search.pagetemplates.model with type parameters of type PageElement

Modifier and Type	Field and Description
private List<List<PageElement>>	Choice.alternatives
private List<PageElement>	Section.elements The elements of this - sources, subsections etc.
private List<PageElement>	Section.renderers Filtered versions of elements pre-calculated at freeze time
private List<PageElement>	Source.renderers
private List<PageElement>	Section.sections Filtered versions of elements pre-calculated at freeze time
private List<PageElement>	Section.sources Filtered versions of elements pre-calculated at freeze time
private List<List<PageElement>>	MapChoice.values

Methods in com.yahoo.search.pagetemplates.model that return types with arguments of type PageElement

Modifier and Type	Method and Description
List<List<PageElement>>	Choice.alternatives() Returns the alternatives of this as a live reference to the alternatives of this.
private List<PageElement>	Section.createElementList(Class pageTemplateModelElementClass)
private static List<PageElement>	Choice.createSingletonList(PageElement member)
List<PageElement>	Section.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>	Section.elements(Class pageTemplateModelElementClass) Convenience method which returns the elements and choices of the given type in elements as a read-only list.
List<PageElement>	Choice.get(int index) Convenience shorthand of return alternatives().get(index)
List<PageElement>	Source.renderers() Returns the renderers or choices of renderers to apply on individual items of this source
List<List<PageElement>>	MapChoice.values() Returns the values (the "from" of the mapping) of this as a live reference which can be modified unless this is frozen.

Methods in com.yahoo.search.pagetemplates.model with parameters of type PageElement

Modifier and Type	Method and Description
static Choice	Choice.createSingleton(PageElement singletonAlternative) Creates a choice having a single alternative having a single page element
private static List<PageElement>	Choice.createSingletonList(PageElement member)

Method parameters in com.yahoo.search.pagetemplates.model with type arguments of type PageElement

Modifier and Type	Method and Description
void	Choice.add(List<PageElement> alternative) Convenience shorthand for if (alternative!=null) alternatives().add(alternative)
static Choice	Choice.createSingletons(List<PageElement> alternatives) Creates a choice in which each alternative consists of a single element

Constructor parameters in com.yahoo.search.pagetemplates.model with type arguments of type PageElement

Constructor and Description
Choice(List<List<PageElement>> alternatives) Creates a choice between some alternatives.