wt.query.template
Class ReportTemplate

java.lang.Object
  wt.fc.WTObject
      wt.enterprise.FolderResident
          wt.query.template.ReportTemplate

All Implemented Interfaces:

AccessControlled, BusinessInformation, CabinetBased, Cloneable, DisplayIdentification, DomainAdministered, Externalizable, Foldered, FolderEntry, FolderServiceManaged, Identified, Indexable, NetFactor, Notifiable, ObjectMappable, Ownable, Persistable, RecentlyVisited, Serializable, WTContained

public class ReportTemplate

extends FolderResident

implements Indexable, Cloneable, Identified, WTContained, Externalizable

This class is a default implementation of a template for reporting. It consists of query source (represented in XML), a XSL specification for the output format, and business object attributes (e.g. name, description).

Use the newReportTemplate static factory method(s), not the ReportTemplate constructor, to construct instances of this class. Instances must be constructed using the static factory(s), in order to ensure proper initialization of the instance.

Supported API: true

Extendable: false

See Also:

Serialized Form

Field Summary

private static String	CLASSNAME
static String	CONTAINER Label for the attribute.
private WTContainerRef	containerReference
private String	description
static String	DESCRIPTION Label for the attribute; Describes this Report Template.
private static int	DESCRIPTION_UPPER_LIMIT
private boolean	domIsValid
private static boolean	enforce
static long	EXTERNALIZATION_VERSION_UID
private IndexerSet	indexerSet
private String	name
static String	NAME Label for the attribute; Unique name that identifies this Report Template.
private static int	NAME_UPPER_LIMIT
protected static long	OLD_FORMAT_VERSION_UID
private DomProcessor	processor
static long	R51_EXTERNALIZATION_VERSION_UID
private static String	RESOURCE
(package private) static long	serialVersionUID
private String	xml
static String	XML Label for the attribute; String representation of the query.
private static int	XML_UPPER_LIMIT
static String	XMLSOURCE Label for the attribute; Provides an abstraction for accessing the query XML.
private XSLSpec	XSLSpec
static String	XSLSPEC Label for the attribute; Specifies the XSL that should be applied to this Report Template.

Fields inherited from class wt.enterprise.FolderResident

CREATOR, CREATOR_EMAIL, CREATOR_FULL_NAME, CREATOR_NAME

Fields inherited from class wt.fc.WTObject

CREATE_TIMESTAMP, MODIFY_TIMESTAMP

Fields inherited from interface wt.index.Indexable

INDEXER_SET

Fields inherited from interface wt.fc.Persistable

IDENTITY, PERSIST_INFO, TYPE

Fields inherited from interface wt.inf.container.WTContained

CONTAINER_ID, CONTAINER_NAME, CONTAINER_REFERENCE

Fields inherited from interface wt.folder.Foldered

CABINET, CABINET_NAME, FOLDERING_INFO

Fields inherited from interface wt.folder.CabinetBased

CABINET_REFERENCE, FOLDER_PATH, LOCATION

Fields inherited from interface wt.admin.DomainAdministered

DOMAIN_REF, INHERITED_DOMAIN

Fields inherited from interface wt.ownership.Ownable

OWNERSHIP

Fields inherited from interface wt.fc.BusinessInformation

BUSINESS_TYPE, IDENTITY

Fields inherited from interface wt.notify.Notifiable

EVENT_SET

Fields inherited from interface wt.identity.DisplayIdentification

DISPLAY_IDENTIFIER, DISPLAY_IDENTITY, DISPLAY_TYPE

Constructor Summary

ReportTemplate()

Method Summary

private void	containerReferenceValidate(WTContainerRef a_ContainerReference)
boolean	equals(Object obj) Indicates whether the given object is equal to this object from a persistence perspective, by comparing the two objects ObjectIdentifiers.
String	getConceptualClassname() Deprecated.
WTContainer	getContainer() Gets the object for the association that plays role: CONTAINER.
String	getContainerName() Gets the value of the attribute: CONTAINER_NAME.
WTContainerRef	getContainerReference() Gets the value of the attribute: CONTAINER_REFERENCE.
String	getDescription() Gets the value of the attribute: DESCRIPTION.
IdentificationObject	getIdentificationObject() Constructs and returns an identification object.
String	getIdentity() Supported API: false
IndexerSet	getIndexerSet() Gets the value of the attribute: INDEXER_SET.
String	getName() Gets the value of the attribute: NAME.
String	getXml() Gets the value of the attribute: XML.
XMLSource	getXMLSource() Gets the value of the attribute: XMLSOURCE.
XSLSpec	getXSLSpec() Gets the value of the attribute: XSLSPEC.
int	hashCode() Returns a hash code for this object based upon its ObjectIdentifier.
private void	nameValidate(String a_Name)
static ReportTemplate	newReportTemplate() Default factory for the class.
void	readExternal(ObjectInput input) Reads the non-transient fields of this class from an external source.
void	readExternal(PersistentRetrieveIfc input) Used by Persistent Data Service to populate the persistent attributes of this class from a persistent store.
private boolean	readOldVersion(ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source, which is not the current version.
protected boolean	readVersion(ReportTemplate thisObject, ObjectInput input, long readSerialVersionUID, boolean passThrough, boolean superDone) Reads the non-transient fields of this class from an external source.
void	setContainer(WTContainer a_Container) Sets the object for the association that plays role: CONTAINER.
void	setContainerReference(WTContainerRef a_ContainerReference) Sets the value of the attribute: CONTAINER_REFERENCE.
void	setDescription(String a_Description) Sets the value of the attribute: DESCRIPTION.
void	setIndexerSet(IndexerSet a_IndexerSet) Sets the value of the attribute: INDEXER_SET.
void	setName(String a_Name) Sets the value of the attribute: NAME.
void	setXml(String a_Xml) Sets the value of the attribute: XML.
void	setXSLSpec(XSLSpec a_XSLSpec) Sets the value of the attribute: XSLSPEC.
void	writeExternal(ObjectOutput output) Writes the non-transient fields of this class to an external source.
void	writeExternal(PersistentStoreIfc output) Used by Persistent Data Service to obtain the values of the persistent attributes of this class, so they can be written to a persistent store.
private void	xmlValidate(String a_Xml)

Methods inherited from class wt.enterprise.FolderResident

getBusinessType, getCabinet, getCabinetName, getCabinetReference, getCreator, getCreatorEMail, getCreatorFullName, getCreatorName, getDomainRef, getEventSet, getFolderingInfo, getFolderPath, getLocation, getOwnership, initialize, isInheritedDomain, readVersion, setDomainRef, setEventSet, setFolderingInfo, setInheritedDomain, setOwnership

Methods inherited from class wt.fc.WTObject

checkAttributes, duplicate, finalize, getClassInfo, getCreateTimestamp, getDisplayIdentifier, getDisplayIdentity, getDisplayType, getModifyTimestamp, getPersistInfo, getType, readVersion, setPersistInfo, toString

Methods inherited from class java.lang.Object

clone, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface wt.fc.Persistable

checkAttributes, getPersistInfo, getType, setPersistInfo

Methods inherited from interface wt.fc.NetFactor

getClassInfo

Field Detail

RESOURCE

private static final String RESOURCE

See Also:

Constant Field Values

CLASSNAME

private static final String CLASSNAME

NAME

public static final String NAME

Label for the attribute; Unique name that identifies this Report Template.

Supported API: true

See Also:

Constant Field Values

NAME_UPPER_LIMIT

private static int NAME_UPPER_LIMIT

name

private String name

XML

public static final String XML

Label for the attribute; String representation of the query.

Supported API: false

See Also:

Constant Field Values

XML_UPPER_LIMIT

private static int XML_UPPER_LIMIT

xml

private String xml

DESCRIPTION

public static final String DESCRIPTION

Label for the attribute; Describes this Report Template.

Supported API: true

See Also:

Constant Field Values

DESCRIPTION_UPPER_LIMIT

private static int DESCRIPTION_UPPER_LIMIT

description

private String description

XMLSOURCE

public static final String XMLSOURCE

Label for the attribute; Provides an abstraction for accessing the query XML.

Supported API: true

See Also:

Constant Field Values

XSLSPEC

public static final String XSLSPEC

Label for the attribute; Specifies the XSL that should be applied to this Report Template.

Supported API: false

See Also:

Constant Field Values

XSLSpec

private XSLSpec XSLSpec

indexerSet

private IndexerSet indexerSet

CONTAINER

public static final String CONTAINER

Label for the attribute.

Supported API: false

See Also:

Constant Field Values

containerReference

private WTContainerRef containerReference

serialVersionUID

static final long serialVersionUID

See Also:

Constant Field Values

EXTERNALIZATION_VERSION_UID

public static final long EXTERNALIZATION_VERSION_UID

See Also:

Constant Field Values

OLD_FORMAT_VERSION_UID

protected static final long OLD_FORMAT_VERSION_UID

See Also:

Constant Field Values

domIsValid

private transient boolean domIsValid

processor

private transient DomProcessor processor

enforce

private static boolean enforce

R51_EXTERNALIZATION_VERSION_UID

public static final long R51_EXTERNALIZATION_VERSION_UID

See Also:

Constant Field Values

Constructor Detail

ReportTemplate

public ReportTemplate()

Method Detail

writeExternal

public void writeExternal(ObjectOutput output)
                   throws IOException

Writes the non-transient fields of this class to an external source.

Supported API: false

Specified by:

writeExternal in interface Externalizable

Overrides:

writeExternal in class FolderResident

Parameters:

output -

Throws:

IOException

readExternal

public void readExternal(ObjectInput input)
                  throws IOException,
                         ClassNotFoundException

Reads the non-transient fields of this class from an external source.

Supported API: false

Specified by:

readExternal in interface Externalizable

Overrides:

readExternal in class FolderResident

Parameters:

input -

Throws:

IOException

ClassNotFoundException

readVersion

protected boolean readVersion(ReportTemplate thisObject,
                              ObjectInput input,
                              long readSerialVersionUID,
                              boolean passThrough,
                              boolean superDone)
                       throws IOException,
                              ClassNotFoundException

Reads the non-transient fields of this class from an external source.

Supported API: false

Parameters:

thisObject -

input -

readSerialVersionUID -

passThrough -

superDone -

Returns:

boolean

Throws:

IOException

ClassNotFoundException

readOldVersion

private boolean readOldVersion(ObjectInput input,
                               long readSerialVersionUID,
                               boolean passThrough,
                               boolean superDone)
                        throws IOException,
                               ClassNotFoundException

Reads the non-transient fields of this class from an external source, which is not the current version.

Parameters:

input -

readSerialVersionUID -

passThrough -

superDone -

Returns:

boolean

Throws:

IOException

ClassNotFoundException

writeExternal

public void writeExternal(PersistentStoreIfc output)
                   throws SQLException,
                          DatastoreException

Used by Persistent Data Service to obtain the values of the persistent attributes of this class, so they can be written to a persistent store.

(Not intended for general use.)

Supported API: false

Specified by:

writeExternal in interface ObjectMappable

Overrides:

writeExternal in class FolderResident

Parameters:

output -

Throws:

SQLException

DatastoreException

readExternal

public void readExternal(PersistentRetrieveIfc input)
                  throws SQLException,
                         DatastoreException

Used by Persistent Data Service to populate the persistent attributes of this class from a persistent store.

(Not intended for general use.)

Supported API: false

Specified by:

readExternal in interface ObjectMappable

Overrides:

readExternal in class FolderResident

Parameters:

input -

Throws:

SQLException

DatastoreException

getConceptualClassname

public String getConceptualClassname()

Deprecated.

Returns the conceptual (modeled) name for the class.

Supported API: false

Specified by:

getConceptualClassname in interface NetFactor

Returns:

String

getName

public String getName()

Gets the value of the attribute: NAME. Unique name that identifies this Report Template.

Supported API: true

Specified by:

getName in interface CabinetBased

Overrides:

getName in class FolderResident

Returns:

String

setName

public void setName(String a_Name)
             throws WTPropertyVetoException

Sets the value of the attribute: NAME. Unique name that identifies this Report Template.

Supported API: true

Parameters:

a_Name -

Throws:

WTPropertyVetoException

nameValidate

private void nameValidate(String a_Name)
                   throws WTPropertyVetoException

Parameters:

a_Name -

Throws:

WTPropertyVetoException

getXml

public String getXml()

Gets the value of the attribute: XML. String representation of the query.

Supported API: false

Returns:

String

setXml

public void setXml(String a_Xml)
            throws WTPropertyVetoException

Sets the value of the attribute: XML. String representation of the query.

Supported API: false

Parameters:

a_Xml -

Throws:

WTPropertyVetoException

xmlValidate

private void xmlValidate(String a_Xml)
                  throws WTPropertyVetoException

Parameters:

a_Xml -

Throws:

WTPropertyVetoException

getDescription

public String getDescription()

Gets the value of the attribute: DESCRIPTION. Describes this Report Template.

Supported API: true

Returns:

String

setDescription

public void setDescription(String a_Description)

Sets the value of the attribute: DESCRIPTION. Describes this Report Template.

Supported API: true

Parameters:

a_Description -

getXMLSource

public XMLSource getXMLSource()
                       throws WTException

Gets the value of the attribute: XMLSOURCE. Provides an abstraction for accessing the query XML.

Supported API: true

Returns:

XMLSource

Throws:

WTException

getXSLSpec

public XSLSpec getXSLSpec()

Gets the value of the attribute: XSLSPEC. Specifies the XSL that should be applied to this Report Template.

Supported API: false

Returns:

XSLSpec

setXSLSpec

public void setXSLSpec(XSLSpec a_XSLSpec)
                throws WTPropertyVetoException

Sets the value of the attribute: XSLSPEC. Specifies the XSL that should be applied to this Report Template.

Supported API: false

Parameters:

a_XSLSpec -

Throws:

WTPropertyVetoException

getIdentity

public String getIdentity()

Supported API: false

Specified by:

getIdentity in interface Persistable

Overrides:

getIdentity in class FolderResident

Returns:

String

newReportTemplate

public static ReportTemplate newReportTemplate()
                                        throws WTException

Default factory for the class.

Supported API: false

Returns:

ReportTemplate

Throws:

WTException

getIndexerSet

public IndexerSet getIndexerSet()

Gets the value of the attribute: INDEXER_SET.

Supported API: false

Specified by:

getIndexerSet in interface Indexable

Returns:

IndexerSet

setIndexerSet

public void setIndexerSet(IndexerSet a_IndexerSet)

Sets the value of the attribute: INDEXER_SET.

Supported API: false

Specified by:

setIndexerSet in interface Indexable

Parameters:

a_IndexerSet -

getIdentificationObject

public IdentificationObject getIdentificationObject()
                                             throws WTException

Constructs and returns an identification object. This method is the only way to obtain an identification object.

Supported API: true

Specified by:

getIdentificationObject in interface Identified

Returns:

IdentificationObject

Throws:

WTException

getContainerName

public String getContainerName()

Gets the value of the attribute: CONTAINER_NAME. The name of the WTContainer this object is assigned to.

Supported API: false

Specified by:

getContainerName in interface WTContained

Returns:

String

getContainer

public WTContainer getContainer()

Gets the object for the association that plays role: CONTAINER.

Supported API: false

Specified by:

getContainer in interface WTContained

Returns:

WTContainer

setContainer

public void setContainer(WTContainer a_Container)
                  throws WTPropertyVetoException,
                         WTException

Sets the object for the association that plays role: CONTAINER.

Supported API: false

Specified by:

setContainer in interface WTContained

Parameters:

a_Container -

Throws:

WTPropertyVetoException

WTException

getContainerReference

public WTContainerRef getContainerReference()

Gets the value of the attribute: CONTAINER_REFERENCE.

Supported API: false

Specified by:

getContainerReference in interface WTContained

Returns:

WTContainerRef

setContainerReference

public void setContainerReference(WTContainerRef a_ContainerReference)
                           throws WTPropertyVetoException

Sets the value of the attribute: CONTAINER_REFERENCE.

Supported API: false

Specified by:

setContainerReference in interface WTContained

Parameters:

a_ContainerReference -

Throws:

WTPropertyVetoException

containerReferenceValidate

private void containerReferenceValidate(WTContainerRef a_ContainerReference)
                                 throws WTPropertyVetoException

Parameters:

a_ContainerReference -

Throws:

WTPropertyVetoException

equals

public boolean equals(Object obj)

Indicates whether the given object is equal to this object from a persistence perspective, by comparing the two objects ObjectIdentifiers. Changed or stale copies are still considered equal by this method. Delegates to PersistenceHelper.equals(Persistable,Object).

Warning: Certain core Windchill operations may depend upon equals being ObjectIdentifier-based. Changes to the default implementation should be done with care, if at all.

Supported API: false

Overrides:

equals in class FolderResident

Parameters:

obj -

Returns:

boolean

hashCode

public int hashCode()

Returns a hash code for this object based upon its ObjectIdentifier. Delegates to PersistenceHelper.hashCode(Persistable).

Warning: Certain core Windchill operations may depend upon hashCode being ObjectIdentifier-based. Changes to the default implementation should be done with care, if at all.

Supported API: false

Overrides:

hashCode in class FolderResident

Returns:

int