Package org.soulwing.prospecto.runtime.template

Class ConcreteViewTemplate

java.lang.Object

org.soulwing.prospecto.runtime.template.ConcreteViewTemplate

All Implemented Interfaces:

ViewTemplate, ComposableViewTemplate

public class ConcreteViewTemplate
extends Object
implements ComposableViewTemplate

A ViewTemplate implementation.

Author:

Carl Harris

Nested Class Summary

Nested classes/interfaces inherited from interface org.soulwing.prospecto.api.ViewTemplate

ViewTemplate.Traversal

Constructor Summary

Constructors

Constructor	Description
ConcreteViewTemplate(AbstractViewNode root)

Method Summary

Modifier and Type	Method	Description
AbstractContainerNode	arrayOfObjects(String name, String elementName, String namespace)	Extracts a view node of array-of-objects type from the root of this template for use as a subview in another template.
ViewTemplate	arrayOfObjectsTemplate(String name, String elementName, String namespace)	Extracts a view template of array-of-objects type from the root of this template.
AbstractContainerNode	arrayOfReferences(String name, String elementName, String namespace)	Extracts a view node of array-of-references type from the root of this template for use as a subview in another template.
ViewTemplate	arrayOfReferencesTemplate(String name, String elementName, String namespace)	Extracts a view template of array-of-references type from the root of this template.
ViewTemplate.Traversal	breadthFirst()
ViewApplicator	createApplicator(View source, ViewContext context)
ViewApplicator	createApplicator(View source, ViewContext context, String dataKey)
ViewTemplate.Traversal	depthFirst()
View	generateView(Object source, ViewContext context)
AbstractViewNode	getRoot()
AbstractContainerNode	object(String name, String namespace)	Extracts a view node of object type from the root of this template for use as a subview in another template.
AbstractContainerNode	reference(String name, String namespace)	Extracts a view node of reference type from the root of this template for use as a subview in another template.

Methods inherited from class java.lang.Object

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

Constructor Detail

ConcreteViewTemplate

public ConcreteViewTemplate(AbstractViewNode root)

Method Detail

getRoot

public AbstractViewNode getRoot()

breadthFirst

public ViewTemplate.Traversal breadthFirst()

Specified by:

breadthFirst in interface ViewTemplate

depthFirst

public ViewTemplate.Traversal depthFirst()

Specified by:

depthFirst in interface ViewTemplate

generateView

public View generateView(Object source,
                         ViewContext context)
                  throws ViewException

Specified by:

generateView in interface ViewTemplate

Throws:

ViewException

createApplicator

public ViewApplicator createApplicator(View source,
                                       ViewContext context)

Specified by:

createApplicator in interface ViewTemplate

createApplicator

public ViewApplicator createApplicator(View source,
                                       ViewContext context,
                                       String dataKey)

Specified by:

createApplicator in interface ViewTemplate

object

public AbstractContainerNode object(String name,
                                    String namespace)

Description copied from interface: ComposableViewTemplate

Extracts a view node of object type from the root of this template for use as a subview in another template.

Specified by:

object in interface ComposableViewTemplate

Parameters:

name - name for the node (as it will appear in the calling template)

namespace - namespace for name and elementName; used in only some view types (e.g. XML)

Returns:

new view node containing the children of the root node of this template

See Also:

ViewTemplateBuilder.object(String, String, ViewTemplate)

reference

public AbstractContainerNode reference(String name,
                                       String namespace)

Description copied from interface: ComposableViewTemplate

Extracts a view node of reference type from the root of this template for use as a subview in another template.

Specified by:

reference in interface ComposableViewTemplate

Parameters:

name - name for the node (as it will appear in the calling template)

namespace - namespace for name and elementName; used in only some view types (e.g. XML)

Returns:

new view node containing the children of the root node of this template

See Also:

ViewTemplateBuilder.reference(String, String, ViewTemplate)

arrayOfObjects

public AbstractContainerNode arrayOfObjects(String name,
                                            String elementName,
                                            String namespace)

Description copied from interface: ComposableViewTemplate

Extracts a view node of array-of-objects type from the root of this template for use as a subview in another template.

Specified by:

arrayOfObjects in interface ComposableViewTemplate

Parameters:

name - name for the node (as it will appear in the calling template)

elementName - name for the elements in the array; used in only some some view types (e.g. XML)

namespace - namespace for name and elementName; used in only some view types (e.g. XML)

Returns:

new view node containing the children of the root node of this template

See Also:

ViewTemplateBuilder.arrayOfObjects(String, String, String, ViewTemplate)

arrayOfReferences

public AbstractContainerNode arrayOfReferences(String name,
                                               String elementName,
                                               String namespace)

Description copied from interface: ComposableViewTemplate

Extracts a view node of array-of-references type from the root of this template for use as a subview in another template.

Specified by:

arrayOfReferences in interface ComposableViewTemplate

Parameters:

name - name for the node (as it will appear in the calling template)

elementName - name for the elements in the array; used in only some some view types (e.g. XML)

namespace - namespace for name and elementName; used in only some view types (e.g. XML)

Returns:

new view node containing the children of the root node of this template

See Also:

ViewTemplateBuilder.arrayOfReferences(String, String, String, ViewTemplate)

arrayOfObjectsTemplate

public ViewTemplate arrayOfObjectsTemplate(String name,
                                           String elementName,
                                           String namespace)

Description copied from interface: ComposableViewTemplate

Extracts a view template of array-of-objects type from the root of this template.

Specified by:

arrayOfObjectsTemplate in interface ComposableViewTemplate

Parameters:

name - name for the root (as it will appear in the calling template)

elementName - name for the elements in the array; used in only some some view types (e.g. XML)

namespace - namespace for name and elementName; used in only some view types (e.g. XML)

Returns:

new view template containing the children of the root node of this template

See Also:

ViewTemplateBuilderProducer.arrayOfObjects(String, String, String, ViewTemplate)

arrayOfReferencesTemplate

public ViewTemplate arrayOfReferencesTemplate(String name,
                                              String elementName,
                                              String namespace)

Description copied from interface: ComposableViewTemplate

Extracts a view template of array-of-references type from the root of this template.

Specified by:

arrayOfReferencesTemplate in interface ComposableViewTemplate

Parameters:

name - name for the root (as it will appear in the calling template)

elementName - name for the elements in the array; used in only some some view types (e.g. XML)

namespace - namespace for name and elementName; used in only some view types (e.g. XML)

Returns:

new view template containing the children of the root node of this template

See Also:

ViewTemplateBuilderProducer.arrayOfReferences(String, String, String, ViewTemplate)