Package com.microstrategy.web.transform

Interface Transforms

  • public interface Transforms
    The Transforms interface exposes a collection of Transform objects.
    Since:
    MicroStrategy Web 7.3.1 or earlier

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      boolean addTransform​(Transform _transform)
      Adds a Transform object to the collection.
      void clear()
      Removes all of the Transform objects from the collection
      int getCount()
      Returns the number of Transform objects in the collection.
      Transform getTransform​(int index)
      Retrieves a specific Transform object by its numeric index.
      Transform getTransform​(java.lang.String name)
      Retrives a specific Transform object by its className.
      Transform remove​(int index)
      Removes the Transform object at the specified position in the collection.
      Transform remove​(Transform trans)
      Removes the Transform object from the collection.
      Transform remove​(java.lang.String className)
      Removes the Transform object with the specified class name from the collection.

    • Method Detail

      • getCount

        int getCount()
        Returns the number of Transform objects in the collection.
        Returns:
        number of Transform objects contained in the collection.
        See Also:
        Transform

      • getTransform

        Transform getTransform​(int index)
                throws java.lang.IndexOutOfBoundsException
        Retrieves a specific Transform object by its numeric index.
        Parameters:
        index - of the Transform object in collection.
        Returns:
        the Transform object in the collection with the given index.
        Throws:
        java.lang.IndexOutOfBoundsException - thrown if the index is invalid.

      • getTransform

        Transform getTransform​(java.lang.String name)
                throws java.lang.IllegalArgumentException
        Retrives a specific Transform object by its className.
        Parameters:
        name - class Name of the Transform object.
        Returns:
        the Transform object in the collection with the given class name.
        Throws:
        java.lang.IllegalArgumentException - thrown if no transform has the given class name in the collection.

      • clear

        void clear()
        Removes all of the Transform objects from the collection

      • remove

        Transform remove​(int index)
          throws java.lang.IndexOutOfBoundsException
        Removes the Transform object at the specified position in the collection.
        Parameters:
        index - of the Transform object to remove.
        Throws:
        IndexOutOfBoundException - thrown if the specified index is out of range.
        java.lang.IndexOutOfBoundsException

      • remove

        Transform remove​(java.lang.String className)
          throws java.lang.IllegalArgumentException
        Removes the Transform object with the specified class name from the collection.
        Parameters:
        className - the name of the Transform object to remove.
        Throws:
        java.lang.IllegalArgumentException - thrown if no transform definition has the given name in the collection.

      • remove

        Transform remove​(Transform trans)
          throws java.lang.IllegalArgumentException
        Removes the Transform object from the collection.
        Parameters:
        trans - the Transform object to remove.
        Throws:
        java.lang.IllegalArgumentException - thrown if no transform has the given class name in the collection.

      • addTransform

        boolean addTransform​(Transform _transform)
              throws java.lang.IllegalArgumentException
        Adds a Transform object to the collection.
        Parameters:
        _transform - the name of the new Transform object.
        Returns:
        true if transform was added, false if the transform is already in the collection.
        Throws:
        java.lang.IllegalArgumentException - thrown if this transform is not in the collection