Package com.microstrategy.web.transform

Class TransformDefnImpl

java.lang.Object

com.microstrategy.utils.config.AbstractConfigurationElement

com.microstrategy.web.transform.AbstractStyleCatalogElement

com.microstrategy.web.transform.TransformDefnImpl

All Implemented Interfaces:

ConfigurationElement, ConfigurationFile, TransformDefn, java.lang.Cloneable

public class TransformDefnImpl
extends AbstractStyleCatalogElement
implements TransformDefn

Since:

MicroStrategy Web 7.3.1 or earlier

Nested Class Summary

Nested classes/interfaces inherited from class com.microstrategy.utils.config.AbstractConfigurationElement

AbstractConfigurationElement.FilteredList

Field Summary

Fields

Modifier and Type	Field	Description
protected static java.lang.String	ATT_CLASS
protected static java.lang.String	ATT_LAYOUT_PARSER
protected static java.lang.String	ATT_NAME
protected static java.lang.String	ATT_PROG_ID
protected static java.lang.String	NODE_TRANSFORM_DEFN

Fields inherited from class com.microstrategy.utils.config.AbstractConfigurationElement

ATT_CONFIG_SRC, ATT_DELETED, ATT_POSITION, ATT_PROTOTYPE, ATT_USE_DEFAULT

Constructor Summary

Constructors

Constructor	Description
TransformDefnImpl()

Method Summary

Modifier and Type	Method	Description
void	checkParamValue(FormalParameter formalParam, java.lang.Object value)	Checks whether the value can be used with the underlying transform.
protected void	clearCaches()	This method is invoked whenever the structure of the style catalog has changed and caches to other objects in the structure needs to be updated.
java.lang.String	getDescription()	Returns the description of the transform associated with the transform definition object.
FormalParameters	getFormalParams()	Returns the formal parameters associated with this transform.
java.lang.String	getImplClassName()	Returns the fully qualified Java Class of the transform associated with the transform definition object.
java.lang.String	getImplProgID()	Gets the COM program ID associated with the transform definition object.
protected java.lang.String	getKeyAttribute()	This method must return the attribute that uniquely identifies this element among its siblings; if no single attribute can be used, return null and override the getKey and setKey methods.
java.lang.String	getLayoutParser()	Returns the name of the current LayoutParserDefn associated with this TransformDefn.
LayoutParserDefn	getLayoutParserDefn()	Gets the layout parser definition object associated with this transform, if one exists.
java.lang.String	getName()	Returns the name of the transform definition object.
java.lang.String	getSupportedBeanType()	Returns a class name of the root class/interface supported by this transform.
Transform	getTransform()	Returns the Transform instance associated with this object.
boolean	isValid()	Returns whether the transform can be instantiated.
void	setImplClassName(java.lang.String _className)	Sets the fully qualified java class of the transform definition object.
void	setImplProgID(java.lang.String _progID)	Sets the COM program ID of the transform definition object.
void	setLayoutParser(java.lang.String value)	Associates a LayoutParserDefn with this TransformDefn based on its name.
void	setLayoutParserDefn(LayoutParserDefn layoutParserDefn)	Sets the layout parser definition object to associate with this transform.
void	setName(java.lang.String _name)	Sets the name of the TransformDefn object.
boolean	supports(java.lang.Class beanClass)	Returns true if the transform supports objects of specified type.
boolean	supports(java.lang.String beanClassName)	Returns true if the transform supports objects of specified type.

Methods inherited from class com.microstrategy.web.transform.AbstractStyleCatalogElement

copyContents, getStyleCatalog, hasChanged, reload, resetChanged, setStrAttribute

Methods inherited from class com.microstrategy.utils.config.AbstractConfigurationElement

addFileSource, applyCustomization, applyCustomizations, cleanUpDeletedElements, clone, delete, deltas, deltas, equalAtts, equalElements, equalNodeValues, equals, equalsIncludingDeletedElements, exportAttributesToXML, exportElementsToXML, exportNodeValueToXML, getAttribute, getAttributes, getBoolAttribute, getChildKey, getConfigSrc, getDTDFileName, getElement, getElement, getElements, getFileLoader, getIntAttribute, getIntAttribute, getKey, getLineNumber, getList, getNextKey, getNodeName, getNodeValue, getNodeValue, getOrCreateElement, getParent, getPosition, getPrototype, getRegisteredClass, getSelfInitPath, getSource, getStrAttribute, getUseDefault, getXMLParserParameters, getXMLSerializerParameters, hashCode, hashCodeAtts, hashCodeElements, hashCodeNodeValues, hasRegisteredClass, initAttributesFromXML, initDefaultAttributes, initElementFromXML, initElementsFromXML, initFromFile, initFromResource, initFromXML, initFromXML, initNodeValueFromXML, initPrototype, isActive, isCustomized, isDeleted, isDirty, isInSource, isKeyAttribute, load, mergeChanges, newChildInstance, newSource, original, populate, printAttributes, printElements, printNodeValue, refreshLists, registerClass, registerElement, registerElement, registerElementList, reloadPrototype, removeAttribute, removeDefaults, replaceList, restore, save, save, saveChangesAs, saveConfig, saveFlatXML, saveNode, saveSource, setAttribute, setBoolAttribute, setChildOriginals, setConfigSrc, setCustomized, setElement, setFileLoader, setIntAttribute, setKey, setLineNumber, setNodeName, setNodeValue, setPosition, setPrototype, setSelfInitPath, setUseDefault, setUseValidation, throwConfigParseException, toString, toXML, toXML, toXML, toXML, useNodeValue, useValidation

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.microstrategy.utils.config.ConfigurationElement

getAttribute, getAttributes, getElement, getElements, getKey, getNodeName, getStrAttribute, initFromXML, reload, toXML

Field Detail

ATT_NAME

protected static final java.lang.String ATT_NAME

Since:

MicroStrategy Web 9.0.0

See Also:

Constant Field Values

ATT_CLASS

protected static final java.lang.String ATT_CLASS

Since:

MicroStrategy Web 9.0.0

See Also:

Constant Field Values

ATT_PROG_ID

protected static final java.lang.String ATT_PROG_ID

Since:

MicroStrategy Web 9.0.0

See Also:

Constant Field Values

ATT_LAYOUT_PARSER

protected static final java.lang.String ATT_LAYOUT_PARSER

Since:

MicroStrategy Web 9.0.0

See Also:

Constant Field Values

NODE_TRANSFORM_DEFN

protected static final java.lang.String NODE_TRANSFORM_DEFN

Since:

MicroStrategy Web 9.0.0

See Also:

Constant Field Values

Constructor Detail

TransformDefnImpl

public TransformDefnImpl()

Since:

MicroStrategy Web 9.0.0

Method Detail

clearCaches

protected void clearCaches()

Description copied from class: AbstractStyleCatalogElement

This method is invoked whenever the structure of the style catalog has changed and caches to other objects in the structure needs to be updated.

Overrides:

clearCaches in class AbstractStyleCatalogElement

Since:

MicroStrategy Web 9.0.0

getName

public java.lang.String getName()

Description copied from interface: TransformDefn

Returns the name of the transform definition object.

Specified by:

getName in interface TransformDefn

Returns:

name of the transform definition object.

setName

public void setName(java.lang.String _name)

Description copied from interface: TransformDefn

Sets the name of the TransformDefn object.

Specified by:

setName in interface TransformDefn

Parameters:

_name - the name of the TransformDefn.

getDescription

public java.lang.String getDescription()
                                throws WebTransformException

Description copied from interface: TransformDefn

Returns the description of the transform associated with the transform definition object.

Specified by:

getDescription in interface TransformDefn

Returns:

description of the transform.

Throws:

WebTransformException - thrown if there was an error getting the description (e.g. Transform did not exist).

getImplProgID

public java.lang.String getImplProgID()

Description copied from interface: TransformDefn

Gets the COM program ID associated with the transform definition object.

Specified by:

getImplProgID in interface TransformDefn

Returns:

COM program ID associated with the transform definition object.

setImplProgID

public void setImplProgID(java.lang.String _progID)

Description copied from interface: TransformDefn

Sets the COM program ID of the transform definition object.

Specified by:

setImplProgID in interface TransformDefn

Parameters:

_progID - the COM program ID to set.

getImplClassName

public java.lang.String getImplClassName()

Description copied from interface: TransformDefn

Returns the fully qualified Java Class of the transform associated with the transform definition object.

Specified by:

getImplClassName in interface TransformDefn

Returns:

fully qualified Java class.

setImplClassName

public void setImplClassName(java.lang.String _className)

Description copied from interface: TransformDefn

Sets the fully qualified java class of the transform definition object.

Specified by:

setImplClassName in interface TransformDefn

Parameters:

_className - the fully qualified class name to set.

getLayoutParser

public java.lang.String getLayoutParser()

Description copied from interface: TransformDefn

Returns the name of the current LayoutParserDefn associated with this TransformDefn.

Specified by:

getLayoutParser in interface TransformDefn

Since:

MicroStrategy Web 9.0.0

setLayoutParser

public void setLayoutParser(java.lang.String value)

Description copied from interface: TransformDefn

Associates a LayoutParserDefn with this TransformDefn based on its name.

Specified by:

setLayoutParser in interface TransformDefn

Since:

MicroStrategy Web 9.0.0

getFormalParams

public FormalParameters getFormalParams()
                                 throws WebTransformException

Description copied from interface: TransformDefn

Returns the formal parameters associated with this transform.

Specified by:

getFormalParams in interface TransformDefn

Returns:

formal parameters of the transform.

Throws:

WebTransformException - thrown if there was an error getting the formal params (e.g. Transform did not exist).

isValid

public boolean isValid()

Description copied from interface: TransformDefn

Returns whether the transform can be instantiated.

Specified by:

isValid in interface TransformDefn

Returns:

whether the transform can be instantiated.

checkParamValue

public void checkParamValue(FormalParameter formalParam,
                            java.lang.Object value)
                     throws java.lang.IllegalArgumentException

Description copied from interface: TransformDefn

Checks whether the value can be used with the underlying transform.

Specified by:

checkParamValue in interface TransformDefn

Parameters:

formalParam - the formal parameter used to check the value.

value - the value wanted to be checked.

Throws:

java.lang.IllegalArgumentException - thrown if the value is not valid.

getSupportedBeanType

public java.lang.String getSupportedBeanType()

Description copied from interface: TransformDefn

Returns a class name of the root class/interface supported by this transform. We assume here that each transform supports only beans belonging to one class hierarchy.

Specified by:

getSupportedBeanType in interface TransformDefn

Returns:

a class name of the root class/interface supported by this transform.

supports

public boolean supports(java.lang.Class beanClass)

Description copied from interface: TransformDefn

Returns true if the transform supports objects of specified type.

Specified by:

supports in interface TransformDefn

Parameters:

beanClass - the Java Class object representing bean type.

Returns:

true if the transform supports objects of specified type.

supports

public boolean supports(java.lang.String beanClassName)

Description copied from interface: TransformDefn

Returns true if the transform supports objects of specified type.

Specified by:

supports in interface TransformDefn

Parameters:

beanClassName - the bean class name.

Returns:

true if the transform supports objects of specified type.

getTransform

public Transform getTransform()

Description copied from interface: TransformDefn

Returns the Transform instance associated with this object.

Specified by:

getTransform in interface TransformDefn

Returns:

The Transform instance associated with this object.

getLayoutParserDefn

public LayoutParserDefn getLayoutParserDefn()

Description copied from interface: TransformDefn

Gets the layout parser definition object associated with this transform, if one exists.

Specified by:

getLayoutParserDefn in interface TransformDefn

Returns:

The layout parser to use with this transform.

Since:

MicroStrategy Web 8.0.0

setLayoutParserDefn

public void setLayoutParserDefn(LayoutParserDefn layoutParserDefn)

Description copied from interface: TransformDefn

Sets the layout parser definition object to associate with this transform.

Specified by:

setLayoutParserDefn in interface TransformDefn

Parameters:

layoutParserDefn - The layout parser to use with this transform.

Since:

MicroStrategy Web 8.0.0

getKeyAttribute

protected java.lang.String getKeyAttribute()

Description copied from class: AbstractConfigurationElement

This method must return the attribute that uniquely identifies this element among its siblings; if no single attribute can be used, return null and override the getKey and setKey methods.

Specified by:

getKeyAttribute in class AbstractConfigurationElement

Since:

MicroStrategy Web 9.0.0