|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectsimple.template.page.PageContainer
public class PageContainer
The PageContainer
provides an implementation of the
Container
object for Page objects. This
can be used with a TemplateEngine
to provide template
documents written in the Java Server Pages (JSP) syntax. This can
use either Groovy or Java JSP templates to produce documents.
Composer
Field Summary | |
---|---|
protected Model |
data
The internal storage used by this instance. |
Constructor Summary | |
---|---|
PageContainer(Context context)
Constructor for the PageContainer object. |
|
PageContainer(Workspace project,
Context context)
Constructor for the PageContainer object. |
Method Summary | |
---|---|
boolean |
contains(java.lang.String name)
The contains method is used to determine if
a mapping exists for the given name. |
boolean |
exists(java.lang.String path)
Determines whether the named template exists. |
java.lang.Object |
get(java.lang.String name)
The get method is used to retrieve the value
mapped to the specified name. |
java.util.Set |
keySet()
To ascertain what mappings exist, the names of all values previously put into this database can be retrieved with this method. |
Document |
lookup(java.lang.String path)
Looks for the named template and wraps the template within a new Document instance. |
Document |
lookup(java.lang.String path,
boolean share)
Looks for the named template and wraps the template within a new Document instance. |
Document |
lookup(java.lang.String path,
java.lang.Object data,
boolean share)
Looks for the named template and wraps the template within a new Document instance. |
void |
put(java.lang.String name,
java.lang.Object value)
The put method is used to insert a mapping in
the database that pairs the issued name with the issued
value. |
void |
remove(java.lang.String name)
The remove method is used to remove the
mapping from the database. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface simple.template.Database |
---|
contains, get, keySet, put, remove |
Field Detail |
---|
protected Model data
Constructor Detail |
---|
public PageContainer(Context context) throws java.lang.Exception
PageContainer
object. The
instance created will use the provided workspace to acquire all
JSP pages referenced. Each page is acquired from the source path.
context
- the context used to acquire the JSP templates
java.lang.Exception
- if there is an initialization problempublic PageContainer(Workspace project, Context context) throws java.lang.Exception
PageContainer
object. The
instance created will use the provided workspace to acquire all
JSP pages referenced. Each page is acquired from the source path.
project
- this is the workspace used to compose templatescontext
- the context used to acquire the JSP templates
java.lang.Exception
- if there is an initialization problemMethod Detail |
---|
public boolean exists(java.lang.String path)
lookup
method will locate a JSP
template given the specified path. If the template is accessible
this returns true, otherwise false is returned.
exists
in interface Container
path
- this is the path used to locate the JSP template
public Document lookup(java.lang.String path) throws java.lang.Exception
Document
instance. Resolving the location
of the template is left up the templating system, typically
this requires a file path reference to locate the template.
The document created by this method is transient, that is, it is a unique instance. This means that changes to the properties of any created document object affect only that instance. By default this assumes the UTF-8 encoding.
lookup
in interface Container
path
- this is the path used to locate the JSP template
java.lang.Exception
- this is thrown if the is a problem with
locating or rendering the specified templatepublic Document lookup(java.lang.String path, boolean share) throws java.lang.Exception
Document
instance. Resolving the location
of the template is left up the templating system, typically
this requires a file path reference to locate the template.
The document created by this method is transient, that is, it is a unique instance. This means that changes to the properties of any created document object affect only that instance. By default this assumes the UTF-8 encoding.
path
- this is the path used to locate the JSP templateshare
- should the document model be inherited or shared
java.lang.Exception
- this is thrown if the is a problem with
locating or rendering the specified templatepublic Document lookup(java.lang.String path, java.lang.Object data, boolean share) throws java.lang.Exception
Document
instance. Resolving the location
of the template is left up the templating system, typically
this requires a file path reference to locate the template.
The document created by this method is transient, that is, it is a unique instance. This means that changes to the properties of any created document object affect only that instance. By default this assumes the UTF-8 encoding.
path
- this is the path used to locate the JSP templatedata
- this provides a set of default propertiesshare
- should the data model be inherited or shared
java.lang.Exception
- this is thrown if the is a problem with
locating or rendering the specified templatepublic void put(java.lang.String name, java.lang.Object value)
put
method is used to insert a mapping in
the database that pairs the issued name with the issued
value. The value can be referenced in future by its name.
Properties set with this method will be set within this
instances data source, which is available to subclasses.
put
in interface Database
name
- this is the name of the value being insertedvalue
- this is the named value that is insertedpublic java.lang.Object get(java.lang.String name)
get
method is used to retrieve the value
mapped to the specified name. If a value does not exist
matching the given name, then this returns null. All the
property values retrieved by this method are obtained
from an internal source that is accessible to subclasses.
get
in interface Database
name
- this is the name of the value to be retrieved
public void remove(java.lang.String name)
remove
method is used to remove the
mapping from the database. This method either removes
the value or returns silently if the name does not exist.
This removes the mapping from the internal data source.
remove
in interface Database
name
- this is the name of the value to be removedpublic java.util.Set keySet()
Set
that
contains the names of all the mappings added to this.
keySet
in interface Database
public boolean contains(java.lang.String name)
contains
method is used to determine if
a mapping exists for the given name. This returns true if
the mapping exists or false otherwise.
contains
in interface Database
name
- this is the name of the mapping to determine
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |