|
Docmosis API 4.5.0 | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.docmosis.template.store.TemplateStoreFactory.PresetTemplateStore
This class facades a real TemplateStore providing values for typical settings that one might use across lots of store requests.
Method Summary | |
void |
deleteAll()
Delete all templates in the store. |
void |
deleteTemplate(TemplateIdentifier templateId)
Delete the given template from the store. |
void |
deleteTemplates(TemplateContext context,
boolean includeSubContexts)
Delete all templates in the given context. |
boolean |
equals(Object obj)
|
TemplateDetails[] |
findByContext(TemplateContext templateContext,
boolean includeSubContexts)
Get the list of templates for the given context. |
InputStream |
getOriginalTemplate(TemplateIdentifier templateId)
Get the original template provided in storeTemplate(). |
Template |
getTemplate(TemplateIdentifier templateId)
Get the (working) template identified by the given templateId. |
TemplateAnalysis |
getTemplateAnalysis(TemplateIdentifier templateId)
Get the template analysis for the template identified by the given template info. |
long |
getTemplateStoredTime(TemplateIdentifier templateId)
Return the time that the template was stored in this template store. |
int |
hashCode()
|
TemplateDetails |
storeTemplate(TemplateIdentifier templateId,
InputStream origTemplateSource,
InputStream workingTemplateSource,
TemplateAnalysis analysis,
InputStream thumbnail,
boolean overwrite,
boolean templateErrorsFatal,
String plainTextFieldPrefix,
String plainTextFieldSuffix,
boolean allowPaddedFields)
Store the given InputStream as a template using the given templateId. |
Methods inherited from class java.lang.Object |
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait |
Method Detail |
public int hashCode()
public boolean equals(Object obj)
public void deleteAll() throws TemplateStoreException
TemplateStore
deleteAll
in interface TemplateStore
TemplateStoreException
- if any of the templates could not be deletedpublic void deleteTemplate(TemplateIdentifier templateId) throws TemplateStoreException
TemplateStore
deleteTemplate
in interface TemplateStore
templateId
- the identifier for the template
TemplateStoreException
- if the template could not be deleted.public void deleteTemplates(TemplateContext context, boolean includeSubContexts) throws TemplateStoreException
TemplateStore
deleteTemplates
in interface TemplateStore
context
- the template context in which all templates are to be deletedincludeSubContexts
- if true all templates in contexts under the given
context will also be deleted.
TemplateStoreException
- if any of the templates could not be deletedpublic TemplateDetails[] findByContext(TemplateContext templateContext, boolean includeSubContexts) throws IOException, TemplateStoreException
TemplateStore
findByContext
in interface TemplateStore
templateContext
- the context under which to find templatesincludeSubContexts
- if true, templates under subcontexts will be returned.
TemplateStoreException
- if a problem occurs specific to the store
IOException
- if an error occurs obtaining the templatepublic InputStream getOriginalTemplate(TemplateIdentifier templateId) throws IOException, TemplateNotFoundException
TemplateStore
getOriginalTemplate
in interface TemplateStore
templateId
- details of the template to retrieve.
IOException
- if an IO problem occurs.
TemplateNotFoundException
- if the specified template is not foundpublic Template getTemplate(TemplateIdentifier templateId) throws IOException, TemplateNotFoundException, TemplateStoreException
TemplateStore
getTemplate
in interface TemplateStore
templateId
- the identifier for the template
IOException
- if an error occurs obtaining the template
TemplateNotFoundException
- if the specified template cannot be found
TemplateStoreException
public TemplateAnalysis getTemplateAnalysis(TemplateIdentifier templateId) throws IOException, TemplateNotFoundException, TemplateStoreException
TemplateStore
getTemplateAnalysis
in interface TemplateStore
templateId
-
TemplateStoreException
- if an error occurs retrieving the analysis
IOException
- if an error occurs obtaining the analysis
TemplateNotFoundException
- if the template cannot be locatedpublic long getTemplateStoredTime(TemplateIdentifier templateId) throws TemplateStoreException
TemplateStore
getTemplateStoredTime
in interface TemplateStore
TemplateStoreException
- if an error occurred while retrieving this information.public TemplateDetails storeTemplate(TemplateIdentifier templateId, InputStream origTemplateSource, InputStream workingTemplateSource, TemplateAnalysis analysis, InputStream thumbnail, boolean overwrite, boolean templateErrorsFatal, String plainTextFieldPrefix, String plainTextFieldSuffix, boolean allowPaddedFields) throws IOException, TemplateAlreadyExistsException, TemplateStoreException
TemplateStore
storeTemplate
in interface TemplateStore
templateId
- the unique identification for this template.origTemplateSource
- an InputStream over the "original" template. This is the
raw template as provided by whatever source (eg a user).workingTemplateSource
- an InputStream over a working template source. This is
expected to be a converted form of the original template that is suitable for populating
by a TemplatePopulator. Specify null if the origTemplateSource should be used as the working
template. The working template is returned by getTemplate().analysis
- the analysis for the template. This may be null and is expected to be
constructed dynamically by some TemplateStore implementations, so most implementations should
simply store what is given.thumbnail
- an image thumbnail for the template. This may be null and is expected to be
constructed dynamically by some TemplateStore implementations, so most implementations of this interface
should simply store what is given.overwrite
- if true, any existing template will be overwritten.templateErrorsFatal
- if true, errors detected in the template will result in a TemplateStoreException.
If false, errors will be highlighted in the template (where possible) and thus be visible when the
document is rendered. Most implementations of this interface can ignore this parameter because it is
used by the TemplateStore implementation that will provide the TemplateAnalysis.plainTextFieldPrefix
- if not null, specifies a prefix to use when analysing templates
to identify Docmosis fields in plain text. Most implementations of this interface can ignore this parameter because it is
used by the TemplateStore implementation that will provide the TemplateAnalysis.plainTextFieldSuffix
- this is the partner to plainTextFieldPrefix and identifies the end of the
field. Most implementations of this interface can ignore this parameter because it is
used by the TemplateStore implementation that will provide the TemplateAnalysis.allowPaddedFields
- when processing the template allow fields padded with spaces to
be included as fields. Most implementations of this interface can ignore this parameter because it is
used by the TemplateStore implementation that will provide the TemplateAnalysis.
TemplateAlreadyExistsException
- if the template is already present and overwrite is not
true
TemplateStoreException
- if any other unexpected error occurs.
IOException
- if an error occurs storing the template
|
Docmosis API 4.5.0 | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |