net.windward.xmlreport

Class TemplateInfo

java.lang.Object

net.windward.xmlreport.TemplateInfo

public class TemplateInfo
extends java.lang.Object

Information about a template. User: David Thielen Date: Sept 23, 2008 Version 7.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TemplateInfo.DataSourceProfile Information stored in the template for a datasource.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAutotagData() Deprecated. This is for internal Windward use only - do not use.
java.lang.String	getAutotagVersion() The version of the metadata.
java.lang.String	getAutotagXml() Deprecated. This is for internal Windward use only - do not use.
java.lang.String	getBatchForEach() The forEach tag (text form) for batch runs.
java.util.List<TemplateInfo.DataSourceProfile>	getDatasourceProfiles() All datasources that must be processed for this template.
java.lang.String[]	getDatasources() All datasources that must be processed for this template.
java.lang.String[]	getPodGuids() Deprecated. POD framing is deprecated.
java.lang.String	getRootPath() The root path for any relative filenames (imports and datasources).
BaseTag[][]	getTags() All of the tags embedded in the template.
int	getTemplateType() One of ProcessReport.TEMPLATE_TYPE_*
TemplateVariable[]	getTemplateVariables() All vars that must be defined by a caller in the template.
java.lang.String[]	getVars() All vars that must be defined by a caller in the template.

Methods inherited from class java.lang.Object

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

Method Detail

getTemplateType

public int getTemplateType()

One of ProcessReport.TEMPLATE_TYPE_*

Returns:

One of ProcessReport.TEMPLATE_TYPE_*

getRootPath

public java.lang.String getRootPath()

The root path for any relative filenames (imports and datasources).

getVars

public java.lang.String[] getVars()

All vars that must be defined by a caller in the template.

Returns:

All vars that must be defined by a caller in the template.

getDatasources

public java.lang.String[] getDatasources()

All datasources that must be processed for this template.

Returns:

All datasources that must be processed for this template.

getPodGuids

public java.lang.String[] getPodGuids()

Deprecated. POD framing is deprecated.

The POD guids in the template.

Returns:

The POD guids in the template.

getTags

public BaseTag[][] getTags()

All of the tags embedded in the template. The first list contains tags found in the Document Body. The second list contains tags found in the Headers/Footers. The third list contains tags found in the Footnotes.

Returns:

All tags that must be processed for this template.

getBatchForEach

public java.lang.String getBatchForEach()

The forEach tag (text form) for batch runs. null if no query.

getAutotagData

public java.lang.String getAutotagData()

Deprecated. This is for internal Windward use only - do not use.

the AutoTag data embedded in the template. null if not requested or does not exist.

Returns:

the AutoTag data embedded in the template.

getDatasourceProfiles

public java.util.List<TemplateInfo.DataSourceProfile> getDatasourceProfiles()

All datasources that must be processed for this template.

Returns:

All datasources AND their information that must be processed for this template.

getTemplateVariables

public TemplateVariable[] getTemplateVariables()

All vars that must be defined by a caller in the template.

Returns:

All vars AND their information that must be defined by a caller in the template.

getAutotagXml

public java.lang.String getAutotagXml()

Deprecated. This is for internal Windward use only - do not use.

The template metadata as an XML file. null if there is none. Warning, this schema can change between versions and use of this property is not supported.

Returns:

The template metadata as an XML file.

getAutotagVersion

public java.lang.String getAutotagVersion()

The version of the metadata. null if no metadata.