com.yahoo.search.pagetemplates.config

Class PageTemplateXMLReader

java.lang.Object

com.yahoo.search.pagetemplates.config.PageTemplateXMLReader

public class PageTemplateXMLReader
extends Object

Reads all page template XML files from a given directory (or list of readers). Instances of this are for single-thread usage only.

Author:

bratseth

Field Summary

Fields

Modifier and Type	Field and Description
private static Logger	logger
private Map<com.yahoo.component.ComponentId,Element>	pageElementsByPageId XML elements by page id - available after phase 1.
private PageTemplateRegistry	registry The registry being constructed

Constructor Summary

Constructors

Constructor and Description
PageTemplateXMLReader()

Method Summary

Modifier and Type	Method and Description
private void	addIfNonNull(PageElement pageElement, List<PageElement> pageElements)
private Map<com.yahoo.component.ComponentId,Element>	createPages(List<com.yahoo.io.reader.NamedReader> pageReaders, boolean validateReaderNames)
private String	nullIfEmpty(String s)
PageTemplateRegistry	read(List<com.yahoo.io.reader.NamedReader> pageReaders, boolean validateReaderNames) Reads all page template xml files in a given list of readers.
PageTemplateRegistry	read(String directory) Reads all page template xml files in a given directory.
private AbstractChoice	readChoice(Element choiceElement)
PageTemplate	readFile(String fileName) Reads a single page template file.
private List<PageElement>	readInclude(Element element) Reads the direct descendant elements of an include
private MapChoice	readMapChoice(Element choiceElement, String method)
private Choice	readNonMapChoice(Element choiceElement, String method)
private int	readOptionalNumber(Element element, String attributeName)
private void	readPageContent(Element pageElement, PageTemplate page)
private PageElement	readPageElement(Element child) Returns the page element corresponding to the given node, never null
private List<PageElement>	readPageElements(Element parent) Returns all page elements found under the given node
private void	readPages()
private Map<String,String>	readParameters(Element containingElement)
private Placeholder	readPlaceholder(Element placeholderElement)
private Renderer	readRenderer(Element rendererElement)
private Section	readSection(Element sectionElement, Section section) Fills a section with attributes and sub-elements from a "section" or "page" element
private Source	readSource(Element sourceElement)
private List<Source>	readSourceAttribute(Element sectionElement)
private List<String>	readSpaceSeparatedAttribute(String attributeName, Element containingElement)
private List<File>	sortFiles(File dir)
private String	stripXmlEnding(String fileName)
private void	validateFileName(String actualName, com.yahoo.component.ComponentId id, String artifactName) Throws an exception if the name is not corresponding to the id

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

logger

private static Logger logger

registry

private PageTemplateRegistry registry

The registry being constructed

pageElementsByPageId

private Map<com.yahoo.component.ComponentId,Element> pageElementsByPageId

XML elements by page id - available after phase 1. Needed for includes.

Constructor Detail

PageTemplateXMLReader

public PageTemplateXMLReader()

Method Detail

read

public PageTemplateRegistry read(String directory)

Reads all page template xml files in a given directory.

Throws:

RuntimeException - if directory is not a readable directory, or if there is some error in the XML

readFile

public PageTemplate readFile(String fileName)

Reads a single page template file.

Throws:

RuntimeException - if fileName is not a readable file, or if there is some error in the XML

sortFiles

private List<File> sortFiles(File dir)

read

public PageTemplateRegistry read(List<com.yahoo.io.reader.NamedReader> pageReaders,
                                 boolean validateReaderNames)

Reads all page template xml files in a given list of readers. This is called from the Vespa configuration model.

Parameters:

validateReaderNames - should be set to true if the readers were created by files, not otherwise

Throws:

RuntimeException - if directory is not a readable directory, or if there is some error in the XML

createPages

private Map<com.yahoo.component.ComponentId,Element> createPages(List<com.yahoo.io.reader.NamedReader> pageReaders,
                                                                 boolean validateReaderNames)

validateFileName

private void validateFileName(String actualName,
                              com.yahoo.component.ComponentId id,
                              String artifactName)

Throws an exception if the name is not corresponding to the id

stripXmlEnding

private String stripXmlEnding(String fileName)

readPages

private void readPages()

readPageContent

private void readPageContent(Element pageElement,
                             PageTemplate page)

readSection

private Section readSection(Element sectionElement,
                            Section section)

Fills a section with attributes and sub-elements from a "section" or "page" element

readPageElements

private List<PageElement> readPageElements(Element parent)

Returns all page elements found under the given node

addIfNonNull

private void addIfNonNull(PageElement pageElement,
                          List<PageElement> pageElements)

readInclude

private List<PageElement> readInclude(Element element)

Reads the direct descendant elements of an include

readPageElement

private PageElement readPageElement(Element child)

Returns the page element corresponding to the given node, never null

readSourceAttribute

private List<Source> readSourceAttribute(Element sectionElement)

readSource

private Source readSource(Element sourceElement)

nullIfEmpty

private String nullIfEmpty(String s)

readPlaceholder

private Placeholder readPlaceholder(Element placeholderElement)

readRenderer

private Renderer readRenderer(Element rendererElement)

readOptionalNumber

private int readOptionalNumber(Element element,
                               String attributeName)

readChoice

private AbstractChoice readChoice(Element choiceElement)

readMapChoice

private MapChoice readMapChoice(Element choiceElement,
                                String method)

readNonMapChoice

private Choice readNonMapChoice(Element choiceElement,
                                String method)

readParameters

private Map<String,String> readParameters(Element containingElement)

readSpaceSeparatedAttribute

private List<String> readSpaceSeparatedAttribute(String attributeName,
                                                 Element containingElement)