Package com.microstrategy.web.beans

Interface TransformInstance

  • public interface TransformInstance
    This interface manages a Transform object and its associated MarkupOutput object. This enables the caller to determine which transform is the "default" one and to associate a unique name for each Transform object.

    A TransformInstance may possibly have no key or a null key associated with it. If such a TransformInstance object is neither the default transform, it becomes unreachable in the sense that it can not be retrieved from the collection of transforms.

    Since:
    MicroStrategy Web 7.3.1 or earlier

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.lang.String getKey()
      Returns the key associated with this instance.
      Transform getTransform()
      Returns the Transform instance held by this instance.
      boolean isDefault()
      Determines whether this instance is the default TransformInstance.
      void setDefault​(boolean def)
      Sets the flag that determines whether the current instance is the default TransformInstance.
      void setFormalParameter​(java.lang.String name, java.lang.String value)
      Convenience method to set a formal parameter.
      void setKey​(java.lang.String key)
      Sets a new key to this instance.

    • Method Detail

      • isDefault

        boolean isDefault()
        Determines whether this instance is the default TransformInstance. Only one TransformInstance could be the default one.
        Returns:
        true if this is the default TransformInstance.

      • setDefault

        void setDefault​(boolean def)
        Sets the flag that determines whether the current instance is the default TransformInstance. Only one TransformInstance could be the default one.
        Parameters:
        def - a boolean value indicating default or not.

      • getKey

        java.lang.String getKey()
        Returns the key associated with this instance. Null key is generally not allowed. A TransformInstance with no key, neither is it the default transform, becomes unreachable from the collection of transforms.
        Returns:
        the key associated with this instance.

      • setKey

        void setKey​(java.lang.String key)
     throws KeyAlreadyExistsException
        Sets a new key to this instance. Null key is generally not allowed. A TransformInstance with no key, neither is it the default transform, becomes unreachable from the collection of transforms.
        Parameters:
        key - a new key to associate with
        Throws:
        KeyAlreadyExistsException - thrown if the key already exists.

      • getTransform

        Transform getTransform()
        Returns the Transform instance held by this instance.
        Returns:
        the Transform instance

      • setFormalParameter

        void setFormalParameter​(java.lang.String name,
                        java.lang.String value)
                 throws java.lang.IllegalArgumentException

        Convenience method to set a formal parameter.

        Parameters:
        name - name of the formal parameter
        value - new value of the formal parameter
        Throws:
        java.lang.IllegalArgumentException - thrown if the formal parameter by the given name does not exist
        Since:
        MicroStrategy Web 8.0.0