Interface Transformable

    • Method Detail

      • getType

        int getType()
        Returns the transformable type as in EnumWebTransformableType.
        Returns:
        the transformable type.
      • addTransform

        TransformInstance addTransform​(Transform transform)
        Adds a Transform object into the collection of transforms. The first transform added is automatically set to be the default transform. Any transform added has a key of value null.

        The collection of TransformInstance is a synchronized collection.

        Parameters:
        transform - a Transform to add
        Returns:
        a TransformInstance holding the transform added.
      • addTransformByClass

        TransformInstance addTransformByClass​(java.lang.String transformClass)
                                       throws WebTransformException
        Adds into the collection of transforms a Transform object with the specified fully qualified class name. The first transform added is automatically set to be the default transform. Any transform added has a key of value null.

        The collection of TransformInstance is a synchronized collection.

        Parameters:
        transformClass - the fully qualified class name of the Transform object to be added.
        Returns:
        a TransformInstance holding the transform added.
        Throws:
        WebTransformException - thrown if the specified transform can not be found or instantiated.
      • addTransformByStyle

        TransformInstance addTransformByStyle​(java.lang.String styleName)
                                       throws WebTransformException
        Adds into the collection of transforms a Transform object with the specified style name. The first transform added is automatically set to be the default transform. Any transform added has a key of value null.

        The collection of TransformInstance is a synchronized collection.

        Parameters:
        styleName - the style name in a style catalog.
        Returns:
        a TransformInstance holding the transform added.
        Throws:
        WebTransformException - thrown if the specified transform can not be instantiated.
      • hasTransform

        boolean hasTransform()
        Returns a boolean value indicating whether there is a default TransformInstance object.
        Returns:
        true if there is a default transform.
      • hasTransform

        boolean hasTransform​(java.lang.String key)
        Returns a boolean value indicating whether there is such a TransformInstance object with the specified key.
        Parameters:
        key - the key of a Transform
        Returns:
        true if there is such a TransformInstance with the specified key.
      • getTransformInstance

        TransformInstance getTransformInstance()
        Returns the default TransformInstance object
        Returns:
        the default TransformInstance object; null if there is no default TransformInstance object.
      • getTransformInstance

        TransformInstance getTransformInstance​(java.lang.String key)
                                        throws KeyDoesNotExistException
        Returns the TransformInstance object with the specified key.
        Parameters:
        key - the key of a TransformInstance.
        Returns:
        the TransformInstance object with the specified key.
        Throws:
        KeyDoesNotExistException - thrown if the key is not found.
      • getTransformInstances

        java.util.Enumeration getTransformInstances()
        Retuns a java.util.Enumeration over all the TransformInstance objects.
        Returns:
        a java.util.Enumeration over all the TransformInstance objects.
      • getBeanContext

        BeanContext getBeanContext()
        Returns the BeanContext instance.
        Returns:
        the BeanContext instance.
      • setBeanContext

        void setBeanContext​(BeanContext beanContext)
        Sets an instance of BeanContext on the current Transformable object.
        Parameters:
        beanContext - a BeanContext object.
      • getMessageString

        java.lang.String getMessageString​(java.lang.String key)
        Returns the string descriptor from a Messages instance, which is in turn retrieved from the BeanContext if any. The string descriptor is mapped by the specified key. A String of value "ERROR" is returned if there is no such a string descriptor.
        Parameters:
        key - the key mapped to a string descriptor in a Messages
        Returns:
        the string descriptor from a Messages.
      • invalidateTransformCache

        void invalidateTransformCache()
        This method is called by any transformable object after collecting data
        Since:
        MicroStrategy Web 8.0.0
      • clearTransforms

        void clearTransforms()
        Deletes all transforms added to the object
        Since:
        MicroStrategy Web 8.0.0
      • addTransformByStyle

        TransformInstance addTransformByStyle​(java.lang.String styleName,
                                              StyleRequestContext context)
                                       throws WebTransformException
        Adds into the collection of transforms a Transform object with the specified style name. The first transform added is automatically set to be the default transform. Any transform added has a key of value null.

        The collection of TransformInstance is a synchronized collection.

        Parameters:
        styleName - the style name in a style catalog.
        context - the StyleRequestContext object.
        Returns:
        a TransformInstance holding the transform added.
        Throws:
        WebTransformException - thrown if the specified transform can not be instantiated.
        Since:
        MicroStrategy Web 8.0.1
      • getMyTransformInstances

        java.util.Enumeration getMyTransformInstances()
        Since:
        MicroStrategy Web 9.0.0