Interface Transform

    • Method Detail

      • getDescription

        java.lang.String getDescription()
        Returns a textual description of the transform.
        Returns:
        The textual description of the transform.
      • getFormalParams

        FormalParameters getFormalParams()
        Returns the collection of formal parameters associated with this transform.
        Returns:
        FormalParameters interface, which is a collection of formal parameters.
      • isResolved

        boolean isResolved()
        Returns whether each required formal parameter has a value associated with it.
        Returns:
        whether each required formal parameter has a value.
      • isPreviewAvailable

        boolean isPreviewAvailable()
        Deprecated.
        This feature is not used
        Returns true if this transform supports preview functionality, false otherwise.
        Returns:
        true if this transform supports preview functionality, false otherwise.
      • getPreview

        MarkupOutput getPreview()
                         throws java.lang.UnsupportedOperationException
        Deprecated.
        This feature is not used
        Produces a preview output for this transform.
        Returns:
        a MarkupOutput containing preview of this transform.
        Throws:
        java.lang.UnsupportedOperationException - in case the transform does not support preview functionality
      • transform

        void transform​(Transformable data,
                       MarkupOutput transOut)
                throws java.lang.ClassCastException
        Transforms the data object and appends result to the transOut.
        Parameters:
        data - an object to transform. It must be of proper type supported by the concrete transform this method called on, or ClassCastExcetption will be thrown
        transOut - the MarkupOutput object where the transform result will be added.
        Throws:
        java.lang.ClassCastException - if data is of the wrong type.
      • getSupportedBeanType

        java.lang.Class getSupportedBeanType()
        Returns a root class/interface supported by this transform. We assume here that each transform supports only beans belonging to one class hierarchy.
        Returns:
        a root class/interface supported by this transform.
      • supports

        boolean supports​(Transformable data)
        Returns true if the transform supports the specified data object. The check is performed only on the object's type, no object state is taken into account.
        Parameters:
        data - a transformable object
        Returns:
        true if the transform supports the data object, false otherwise.
        See Also:
        canTransform(com.microstrategy.web.beans.Transformable)
      • 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.
      • canTransform

        boolean canTransform​(Transformable data)
        Checks that the transform supports specified data object and that object is in the state supported by this transform.
        Returns:
        true if the transform supports specified data object and the object is in the state supported by this transform.
      • getID

        java.lang.String getID()
        Returns the unique name of the component to be used as the ID for its shell
        Returns:
        the component's unique id
        Since:
        MicroStrategy Web 8.0.0