Package com.microstrategy.web.transform

Interface TransformDefn

  • All Superinterfaces:
    java.lang.Cloneable, ConfigurationElement
    All Known Implementing Classes:
    TransformDefnImpl
    public interface TransformDefn
extends ConfigurationElement
    The TransformDefn interface is used to manage the data of a transform object.
    Since:
    MicroStrategy Web 7.3.1 or earlier

    • Method Detail

      • getName

        java.lang.String getName()
        Returns the name of the transform definition object.
        Returns:
        name of the transform definition object.

      • getDescription

        java.lang.String getDescription()
                         throws WebTransformException
        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).

      • getImplProgID

        java.lang.String getImplProgID()
        Gets the COM program ID associated with the transform definition object.
        Returns:
        COM program ID associated with the transform definition object.

      • setImplProgID

        void setImplProgID​(java.lang.String progID)
        Sets the COM program ID of the transform definition object.
        Parameters:
        progID - the COM program ID to set.

      • getImplClassName

        java.lang.String getImplClassName()
        Returns the fully qualified Java Class of the transform associated with the transform definition object.
        Returns:
        fully qualified Java class.

      • setImplClassName

        void setImplClassName​(java.lang.String className)
        Sets the fully qualified java class of the transform definition object.
        Parameters:
        className - the fully qualified class name to set.

      • getLayoutParser

        java.lang.String getLayoutParser()
        Returns the name of the current LayoutParserDefn associated with this TransformDefn.
        Since:
        MicroStrategy Web 9.0.0

      • setLayoutParser

        void setLayoutParser​(java.lang.String name)
        Associates a LayoutParserDefn with this TransformDefn based on its name.
        Since:
        MicroStrategy Web 9.0.0

      • getFormalParams

        FormalParameters getFormalParams()
                          throws WebTransformException
        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).

      • isValid

        boolean isValid()
        Returns whether the transform can be instantiated.
        Returns:
        whether the transform can be instantiated.

      • checkParamValue

        void checkParamValue​(FormalParameter formalParam,
                     java.lang.Object value)
              throws java.lang.IllegalArgumentException
        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:
        java.lang.IllegalArgumentException - thrown if the value is not valid.

      • setName

        void setName​(java.lang.String name)
      throws java.lang.IllegalArgumentException
        Sets the name of the TransformDefn object.
        Parameters:
        name - the name of the TransformDefn.
        Throws:
        java.lang.IllegalArgumentException - thrown if the name is invalid or if it is already being used by another TransformDefn object.

      • getSupportedBeanType

        java.lang.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.

      • supports

        boolean supports​(java.lang.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.

      • supports

        boolean supports​(java.lang.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.

      • getTransform

        Transform getTransform()
        Returns the Transform instance associated with this object.
        Returns:
        The Transform instance associated with this object.

      • getLayoutParserDefn

        LayoutParserDefn getLayoutParserDefn()
        Gets the layout parser definition object associated with this transform, if one exists.
        Returns:
        The layout parser to use with this transform.
        Since:
        MicroStrategy Web 8.0.0

      • setLayoutParserDefn

        void setLayoutParserDefn​(LayoutParserDefn layoutParserDefn)
        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.
        Since:
        MicroStrategy Web 8.0.0