public interface

TransformDefn

implements ConfigurationElement
com.microstrategy.web.transform.TransformDefn
Known Indirect Subclasses

Class Overview

The TransformDefn interface is used to manage the data of a transform object.

Summary

Public Methods
abstract void checkParamValue(FormalParameter formalParam, Object value)
Checks whether the value can be used with the underlying transform.
abstract String getDescription()
Returns the description of the transform associated with the transform definition object.
abstract FormalParameters getFormalParams()
Returns the formal parameters associated with this transform.
abstract String getImplClassName()
Returns the fully qualified Java Class of the transform associated with the transform definition object.
abstract String getImplProgID()
Gets the COM program ID associated with the transform definition object.
abstract String getLayoutParser()
Returns the name of the current LayoutParserDefn associated with this TransformDefn.
abstract LayoutParserDefn getLayoutParserDefn()
Gets the layout parser definition object associated with this transform, if one exists.
abstract String getName()
Returns the name of the transform definition object.
abstract String getSupportedBeanType()
Returns a class name of the root class/interface supported by this transform.
abstract Transform getTransform()
Returns the Transform instance associated with this object.
abstract boolean isValid()
Returns whether the transform can be instantiated.
abstract void setImplClassName(String className)
Sets the fully qualified java class of the transform definition object.
abstract void setImplProgID(String progID)
Sets the COM program ID of the transform definition object.
abstract void setLayoutParser(String name)
Associates a LayoutParserDefn with this TransformDefn based on its name.
abstract void setLayoutParserDefn(LayoutParserDefn layoutParserDefn)
This method is deprecated. The LayoutParserDefn should not be explicitly set, it should be resolved automatically by the Style TransformDefn from the getLayoutParser() property
abstract void setName(String name)
Sets the name of the TransformDefn object.
abstract boolean supports(Class beanClass)
Returns true if the transform supports objects of specified type.
abstract boolean supports(String beanClassName)
Returns true if the transform supports objects of specified type.
[Expand]
Inherited Methods
From interface com.microstrategy.utils.config.ConfigurationElement

Public Methods

public abstract 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 thrown if the value is not valid.

public abstract String getDescription ()

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

Returns
  • description of the transform.
Throws
WebTransformException thrown if there was an error getting the description (e.g. Transform did not exist).

public abstract FormalParameters getFormalParams ()

Returns the formal parameters associated with this transform.

Returns
  • formal parameters of the transform.
Throws
WebTransformException thrown if there was an error getting the formal params (e.g. Transform did not exist).

public abstract String getImplClassName ()

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

Returns
  • fully qualified Java class.

public abstract String getImplProgID ()

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

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

public abstract String getLayoutParser ()

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

public abstract 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 abstract String getName ()

Returns the name of the transform definition object.

Returns
  • name of the transform definition object.

public abstract 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 abstract Transform getTransform ()

Returns the Transform instance associated with this object.

Returns
  • The Transform instance associated with this object.

public abstract boolean isValid ()

Returns whether the transform can be instantiated.

Returns
  • whether the transform can be instantiated.

public abstract 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 abstract void setImplProgID (String progID)

Sets the COM program ID of the transform definition object.

Parameters
progID the COM program ID to set.

public abstract void setLayoutParser (String name)

Associates a LayoutParserDefn with this TransformDefn based on its name.

public abstract void setLayoutParserDefn (LayoutParserDefn layoutParserDefn)

This method is deprecated.
The LayoutParserDefn should not be explicitly set, it should be resolved automatically by the Style TransformDefn from the getLayoutParser() property

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

Parameters
layoutParserDefn The layout parser to use with this transform.

public abstract void setName (String name)

Sets the name of the TransformDefn object.

Parameters
name the name of the TransformDefn.
Throws
IllegalArgumentException thrown if the name is invalid or if it is already being used by another TransformDefn object.

public abstract 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 abstract 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.