public class

TransformDefnImpl

extends AbstractStyleCatalogElement
implements TransformDefn
java.lang.Object
   ↳ com.microstrategy.utils.config.AbstractConfigurationElement
     ↳ com.microstrategy.web.transform.AbstractStyleCatalogElement
       ↳ com.microstrategy.web.transform.TransformDefnImpl

Summary

Constants
String ATT_CLASS
String ATT_LAYOUT_PARSER
String ATT_NAME
String ATT_PROG_ID
String NODE_TRANSFORM_DEFN
[Expand]
Inherited Constants
From class com.microstrategy.utils.config.AbstractConfigurationElement
Public Constructors
TransformDefnImpl()
Public Methods
void checkParamValue(FormalParameter formalParam, Object value)
Checks whether the value can be used with the underlying transform.
String getDescription()
Returns the description of the transform associated with the transform definition object.
FormalParameters getFormalParams()
Returns the formal parameters associated with this transform.
String getImplClassName()
Returns the fully qualified Java Class of the transform associated with the transform definition object.
String getImplProgID()
Gets the COM program ID associated with the transform definition object.
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.
String getName()
Returns the name of the transform definition object.
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(String _className)
Sets the fully qualified java class of the transform definition object.
void setImplProgID(String _progID)
Sets the COM program ID of the transform definition object.
void setLayoutParser(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(String _name)
Sets the name of the TransformDefn object.
boolean supports(Class beanClass)
Returns true if the transform supports objects of specified type.
boolean supports(String beanClassName)
Returns true if the transform supports objects of specified type.
Protected Methods
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.
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.
[Expand]
Inherited Methods
From class com.microstrategy.web.transform.AbstractStyleCatalogElement
From class com.microstrategy.utils.config.AbstractConfigurationElement
From class java.lang.Object
From interface com.microstrategy.utils.config.ConfigurationElement
From interface com.microstrategy.utils.config.ConfigurationFile
From interface com.microstrategy.web.transform.TransformDefn

Constants

protected static final String ATT_CLASS

Constant Value: "class"

protected static final String ATT_LAYOUT_PARSER

Constant Value: "layout_parser"

protected static final String ATT_NAME

Constant Value: "name"

protected static final String ATT_PROG_ID

Constant Value: "progID"

protected static final String NODE_TRANSFORM_DEFN

Constant Value: "TransformDefn"

Public Constructors

public TransformDefnImpl ()

Public Methods

public void checkParamValue (FormalParameter formalParam, Object value)

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

Parameters
formalParam the formal parameter used to check the value.
value the value wanted to be checked.
Throws
IllegalArgumentException

public String getDescription ()

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

Returns
  • description of the transform.

public FormalParameters getFormalParams ()

Returns the formal parameters associated with this transform.

Returns
  • formal parameters of the transform.

public String getImplClassName ()

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

Returns
  • fully qualified Java class.

public String getImplProgID ()

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

Returns
  • COM program ID associated with the transform definition object.

public String getLayoutParser ()

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

public LayoutParserDefn getLayoutParserDefn ()

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

Returns
  • The layout parser to use with this transform.

public String getName ()

Returns the name of the transform definition object.

Returns
  • name of the transform definition object.

public String getSupportedBeanType ()

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.

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

public Transform getTransform ()

Returns the Transform instance associated with this object.

Returns
  • The Transform instance associated with this object.

public boolean isValid ()

Returns whether the transform can be instantiated.

Returns
  • whether the transform can be instantiated.

public void setImplClassName (String _className)

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

Parameters
_className the fully qualified class name to set.

public void setImplProgID (String _progID)

Sets the COM program ID of the transform definition object.

Parameters
_progID the COM program ID to set.

public void setLayoutParser (String value)

Associates a LayoutParserDefn with this TransformDefn based on its name.

public void setLayoutParserDefn (LayoutParserDefn layoutParserDefn)

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

Parameters
layoutParserDefn The layout parser to use with this transform.

public void setName (String _name)

Sets the name of the TransformDefn object.

Parameters
_name the name of the TransformDefn.

public boolean supports (Class beanClass)

Returns true if the transform supports objects of specified type.

Parameters
beanClass the Java Class object representing bean type.
Returns
  • true if the transform supports objects of specified type.

public boolean supports (String beanClassName)

Returns true if the transform supports objects of specified type.

Parameters
beanClassName the bean class name.
Returns
  • true if the transform supports objects of specified type.

Protected Methods

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.

protected 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.