Template (stumps 1.0-SNAPSHOT API)

java.lang.Object
- com.neurosys.domain.ModelObject
- - com.neurosys.template.model.Template<REF>

Type Parameters:

REF - as Reference to Type of Page the template points to. See getReference()

All Implemented Interfaces:

ChangeGenerator, ISection, Serializable

Direct Known Subclasses:

AuthorizableTemplate, CategoryTemplate, EntityTemplate, ProductTemplate
```
public class Template<REF>
extends ModelObject
implements ISection, ChangeGenerator
```
A Template is associated with markup HTML and an implementation class like Velocity, or Wicket Components.
It is replaceable because, the page decides which template it uses and the template hierarchy is not hard coded compile time.
A Template is uniquely identified by its name in the application. (id is for backend identification by say a DB) If no DB is in use, Id can also be null for this reason, name is the preferred identifier.
Note: hashCode & equals implementation rely solely on name

Author:

Arjun Dhar

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

protected List<ChangeListener> listeners

static org.apache.commons.collections.Transformer TEMPLATE_IDENTIFIER

Fields
Modifier and Type	Field and Description
`protected List<ChangeListener>`	`listeners`
`static org.apache.commons.collections.Transformer`	`TEMPLATE_IDENTIFIER`

Constructor Summary

Constructors
Constructor and Description

Template()

Template(String name)

Template(Template template)

Constructors
Constructor and Description
`Template()`
`Template(String name)`
`Template(Template template)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addChangeListener(ChangeListener changeListener)` Notify all `ChangeListener`s about a change
`boolean`	`equals(Object obj)`
`EnsureAccessorExistsTransformer`	`getAccessorExistsTransformer()` While creating new records some nested entities may need to be constructed before `#save(Serializable, MetaItem, Object)`
`Map<String,?>`	`getAttributes()`
`Map<String,String>`	`getDefaultResourceLocations()` If the system is unable to derive the path for a given resource where should it be placed Each key corresponds to a file based ContentType Property name from FacetMeta or A Field that is Annotated with Type and has a File based ContentType Note: These paths must be absolute always and may employ the variable; example with AppSettings.get().CONTEXT_BASE_ABSOLUTE_PATH.
`String`	`getDisplayName()` User friendly display name : Useful in Admin view etc.
`FacetMeta`	`getFacetMeta(String facetName)`
`Collection<FacetMeta>`	`getFacets()` What all dynamic place holders does the template have.
`List<String>`	`getFieldOrderListing()` List of field/attribute Names as String that govern the order of listing in the form.
`Long`	`getId()`
`List`	`getListeners()` Get list directly.
`String`	`getMarkupLocation()` In addition to reference, if there is a specific location we want to offer to override or change default path, configure alternate location of the template markup.
`String`	`getName()` Unique identification name
`IPublisherAdapter`	`getPublishAdapter()`
`Class<REF>`	`getReference()` The reference to the class that will construct the template (A factory or a self instantiating bean) The template is bound a Type of class reference which has the actual implementation and wiring to the native framework.
`org.apache.commons.collections.Transformer`	`getSubmitTransformer()` Entity level submission; the entity is the input to the `Transformer` During Submission of the entity backing the template one can apply this. The exact order of the calling is usage dependent, but typically it will be @ the end of the process after all the fields `FacetMeta.getSubmitTransformer()` are processed.
`int`	`hashCode()`
`boolean`	`isProcessFields()` If true will Consider the core entity field definitions while preparing the `MetaItem` list for the Entity.
`void`	`notifyAllListeners(Object object)` Whenever a node is selected, it also notifies its listeners.
`void`	`publish(Object entity)` A service method to publish content/entity that the template represents Each Template knows how to publish its content also; will publish it if a `IPublisherAdapter` is provided
`void`	`setAccessorExistsTransformer(EnsureAccessorExistsTransformer accessorExistsTransformer)` While creating new records some nested entities may need to be constructed before `#save(Serializable, MetaItem, Object)`
`void`	`setAttributes(Map<String,?> attributes)`
`void`	`setDefaultResourceLocations(Map<String,String> defaultResourceLocations)` If the system is unable to derive the path for a given resource where should it be placed Each key corresponds to a file based ContentType Property name from FacetMeta or A Field that is Annotated with Type and has a File based ContentType Note: These paths must be absolute always and may employ the variable; example with AppSettings.get().CONTEXT_BASE_ABSOLUTE_PATH.
`void`	`setDisplayName(String displayName)` User friendly display name : Useful in Admin view etc.
`void`	`setFacets(Collection<FacetMeta> facets)` What all dynamic place holders does the template have.
`void`	`setFieldOrderListing(List<String> fieldOrderListing)` List of field/attribute Names as String that govern the order of listing in the form.
`void`	`setId(Long id)`
`void`	`setListeners(List listeners)` Set list directly.
`void`	`setMarkupLocation(String markupLocation)` In addition to reference, if there is a specific location we want to offer to override or change default path, configure alternate location of the template markup.
`void`	`setName(String name)` Unique identification name
`void`	`setProcessFields(boolean processFields)` If true will Consider the core entity field definitions while preparing the `MetaItem` list for the Entity.
`void`	`setPublishAdapter(IPublisherAdapter publishAdapter)`
`void`	`setReference(Class<REF> reference)` The reference to the class that will construct the template (A factory or a self instantiating bean) The template is bound a Type of class reference which has the actual implementation and wiring to the native framework.
`void`	`setSubmitTransformer(org.apache.commons.collections.Transformer submitTransformer)` Entity level submission; the entity is the input to the `Transformer` During Submission of the entity backing the template one can apply this. The exact order of the calling is usage dependent, but typically it will be @ the end of the process after all the fields `FacetMeta.getSubmitTransformer()` are processed.
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - TEMPLATE_IDENTIFIER
```
public static final org.apache.commons.collections.Transformer TEMPLATE_IDENTIFIER
```
  - listeners
```
protected transient List<ChangeListener> listeners
```
- Constructor Detail
  - Template
```
public Template()
```
  - Template
```
public Template(String name)
```
  - Template
```
public Template(Template template)
```
- Method Detail
  - getId
```
public Long getId()
```
  - setId
```
public void setId(Long id)
```
  - getName
```
public String getName()
```
    Unique identification name
    
    Specified by:
    
    getName in interface ISection
    
    Returns:
    
    String
  - setName
```
public void setName(String name)
```
    Unique identification name
    
    Specified by:
    
    setName in interface ISection
    
    Parameters:
    
    name - as String
  - getDisplayName
```
public String getDisplayName()
```
    User friendly display name : Useful in Admin view etc.
    
    Specified by:
    
    getDisplayName in interface ISection
  - setDisplayName
```
public void setDisplayName(String displayName)
```
    User friendly display name : Useful in Admin view etc.
    
    Specified by:
    
    setDisplayName in interface ISection
  - getReference
```
public Class<REF> getReference()
```
    The reference to the class that will construct the template (A factory or a self instantiating bean)
    The template is bound a Type of class reference which has the actual implementation and wiring to the native framework.
    For example this could be a page or panel in Wicket or a Velocity Template factory class. This is a reference to a type of front End UI that will be instantiated using the Template by the templating engine/process.
  - setReference
```
public void setReference(Class<REF> reference)
```
    The reference to the class that will construct the template (A factory or a self instantiating bean)
    The template is bound a Type of class reference which has the actual implementation and wiring to the native framework.
    For example this could be a page or panel in Wicket or a Velocity Template factory class. This is a reference to a type of front End UI that will be instantiated using the Template by the templating engine/process.
  - getFacets
```
public Collection<FacetMeta> getFacets()
```
    What all dynamic place holders does the template have. A Page must satisfy the templates need to fill those place holders, dynamically. A Page(ContentDescriber)'s facets should match the Templates facets.
    
    See Also:
    
    ContentDescriber#getFacets()}
  - setFacets
```
public void setFacets(Collection<FacetMeta> facets)
```
    What all dynamic place holders does the template have. A Page must satisfy the templates need to fill those place holders, dynamically. A Page(ContentDescriber)'s facets should match the Templates facets.
    
    See Also:
    
    ContentDescriber#getFacets()}
  - getFieldOrderListing
```
public List<String> getFieldOrderListing()
```
    List of field/attribute Names as String that govern the order of listing in the form.
    Note: The field/attribute name is equivalent to what is derived from MetaItem.getName()
  - setFieldOrderListing
```
public void setFieldOrderListing(List<String> fieldOrderListing)
```
    List of field/attribute Names as String that govern the order of listing in the form.
    Note: The field/attribute name is equivalent to what is derived from MetaItem.getName()
  - getDefaultResourceLocations
```
public Map<String,String> getDefaultResourceLocations()
```
    If the system is unable to derive the path for a given resource where should it be placed Each key corresponds to a file based ContentType Property name from FacetMeta or A Field that is Annotated with Type and has a File based ContentType Note: These paths must be absolute always and may employ the variable; example with AppSettings.get().CONTEXT_BASE_ABSOLUTE_PATH. Sample value: /home/abc/public_html/
  - setDefaultResourceLocations
```
public void setDefaultResourceLocations(Map<String,String> defaultResourceLocations)
```
    If the system is unable to derive the path for a given resource where should it be placed Each key corresponds to a file based ContentType Property name from FacetMeta or A Field that is Annotated with Type and has a File based ContentType Note: These paths must be absolute always and may employ the variable; example with AppSettings.get().CONTEXT_BASE_ABSOLUTE_PATH. Sample value: /home/abc/public_html/
  - getMarkupLocation
```
public String getMarkupLocation()
```
    In addition to reference, if there is a specific location we want to offer to override or change default path, configure alternate location of the template markup. This location maybe a Web URL or a relative to the root Web-Context by definition, but a particular implementation of TemplatePageLocator may override the meaning. See specific implementation to be sure.
    
    See Also:
    
    IPageLocator}, TemplatePageLocator}
  - setMarkupLocation
```
public void setMarkupLocation(String markupLocation)
```
    In addition to reference, if there is a specific location we want to offer to override or change default path, configure alternate location of the template markup. This location maybe a Web URL or a relative to the root Web-Context by definition, but a particular implementation of TemplatePageLocator may override the meaning. See specific implementation to be sure.
    
    See Also:
    
    IPageLocator}, TemplatePageLocator}
  - getPublishAdapter
```
public IPublisherAdapter getPublishAdapter()
```
    Can be null:
    
    true
  - setPublishAdapter
```
public void setPublishAdapter(IPublisherAdapter publishAdapter)
```
    Can be null:
    
    true
  - getAttributes
```
public Map<String,?> getAttributes()
```
    Can be null:
    
    true
  - setAttributes
```
public void setAttributes(Map<String,?> attributes)
```
    Can be null:
    
    true
  - getSubmitTransformer
```
public org.apache.commons.collections.Transformer getSubmitTransformer()
```
    Entity level submission; the entity is the input to the Transformer During Submission of the entity backing the template one can apply this.
    The exact order of the calling is usage dependent, but typically it will be @ the end of the process after all the fields FacetMeta.getSubmitTransformer() are processed.
  - setSubmitTransformer
```
public void setSubmitTransformer(org.apache.commons.collections.Transformer submitTransformer)
```
    Entity level submission; the entity is the input to the Transformer During Submission of the entity backing the template one can apply this.
    The exact order of the calling is usage dependent, but typically it will be @ the end of the process after all the fields FacetMeta.getSubmitTransformer() are processed.
  - isProcessFields
```
public boolean isProcessFields()
```
    If true will Consider the core entity field definitions while preparing the MetaItem list for the Entity.
    
    Default value:
    
    true
  - setProcessFields
```
public void setProcessFields(boolean processFields)
```
    If true will Consider the core entity field definitions while preparing the MetaItem list for the Entity.
    
    Default value:
    
    true
  - publish
```
public void publish(Object entity)
             throws Exception
```
    A service method to publish content/entity that the template represents
    
    Each Template knows how to publish its content also; will publish it if a IPublisherAdapter is provided
    
    Parameters:
    
    content/entity -
    
    Throws:
    
    Exception
  - getAccessorExistsTransformer
```
public EnsureAccessorExistsTransformer getAccessorExistsTransformer()
```
    While creating new records some nested entities may need to be constructed before #save(Serializable, MetaItem, Object)
  - setAccessorExistsTransformer
```
public void setAccessorExistsTransformer(EnsureAccessorExistsTransformer accessorExistsTransformer)
```
    While creating new records some nested entities may need to be constructed before #save(Serializable, MetaItem, Object)
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getFacetMeta
```
public FacetMeta getFacetMeta(String facetName)
```
    Parameters:
    
    template - as Template
    
    facetName - name of facet to look for
    
    Returns:
    
    FacetMeta @nullable true
  - addChangeListener
```
public void addChangeListener(ChangeListener changeListener)
```
    Notify all ChangeListeners about a change
    
    Specified by:
    
    addChangeListener in interface ChangeGenerator
    
    Parameters:
    
    changeListener -
  - getListeners
```
public List getListeners()
```
    Description copied from interface: ChangeGenerator
    
    Get list directly. Support DI; like Spring IOC
    
    Specified by:
    
    getListeners in interface ChangeGenerator
  - setListeners
```
public void setListeners(List listeners)
```
    Description copied from interface: ChangeGenerator
    
    Set list directly. Support DI; like Spring IOC
    
    Specified by:
    
    setListeners in interface ChangeGenerator
  - notifyAllListeners
```
public void notifyAllListeners(Object object)
```
    Whenever a node is selected, it also notifies its listeners.
    
    Specified by:
    
    notifyAllListeners in interface ChangeGenerator
    
    Parameters:
    
    object -

Class Template<REF>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

TEMPLATE_IDENTIFIER

listeners

Constructor Detail

Template

Template

Template

Method Detail

getId

setId

getName

setName

getDisplayName

setDisplayName

getReference

setReference

getFacets

setFacets

getFieldOrderListing

setFieldOrderListing

getDefaultResourceLocations

setDefaultResourceLocations

getMarkupLocation

setMarkupLocation

getPublishAdapter

setPublishAdapter

getAttributes

setAttributes

getSubmitTransformer

setSubmitTransformer

isProcessFields

setProcessFields

publish

getAccessorExistsTransformer

setAccessorExistsTransformer

equals

hashCode

toString

getFacetMeta

addChangeListener

getListeners

setListeners

notifyAllListeners