Package com.microstrategy.utils.serialization

Class PersistableAdapter

  • All Implemented Interfaces:
    EnumWebPersistableState, Persistable
    Direct Known Subclasses:
    ProjectInfoPersister
    public class PersistableAdapter
extends java.lang.Object
implements Persistable
    The Persistable interface should be implemented by any class whose instances are intended to be saved into a java.lang.String representation. The saved state should be HTML compatible, which means, it could appear in any form, such as HTML form data, query string, cookies, or session variable.
    Since:
    MicroStrategy Web 7.3.1 or earlier

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean restoreState​(SAXSupport parser, java.lang.String uri, java.lang.String localName, java.lang.String qName, org.xml.sax.Attributes attrs)
      Restores a component from an embedded XML during a SAX parsing.
      boolean restoreState​(java.lang.String state)
      Restores a component based on its saved state.
      java.lang.String saveState()
      Returns a java.lang.String representation of a component.
      java.lang.String saveState​(int howMuchState)
      Returns a java.lang.String representation of a component.
      void saveState​(java.lang.StringBuffer buf, int howMuchState)
      Saves and stores a component's state into a StringBuffer.
      void saveState​(java.lang.StringBuffer buf, int howMuchState, int stateFlag)
      Saves and stores a component's state into a StringBuffer.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • PersistableAdapter

        public PersistableAdapter()

    • Method Detail

      • saveState

        public java.lang.String saveState​(int howMuchState)
        Description copied from interface: Persistable
        Returns a java.lang.String representation of a component. The returned state should be HTML friendly. This method call is equivalent to call saveState(new StringBuffer(), howMuchState).
        Specified by:
        saveState in interface Persistable
        Parameters:
        howMuchState - how much state information to save (EnumWebPersistableState).
        Returns:
        the serialized state of a component.

      • saveState

        public java.lang.String saveState()
        Description copied from interface: Persistable
        Returns a java.lang.String representation of a component. The returned state should be HTML friendly. This method call is equivalent to call saveState(EnumWebPersistableState.TYPICAL_STATE_INFO).
        Specified by:
        saveState in interface Persistable
        Returns:
        the serialized state of a component.

      • restoreState

        public boolean restoreState​(java.lang.String state)
        Description copied from interface: Persistable
        Restores a component based on its saved state.
        Specified by:
        restoreState in interface Persistable
        Parameters:
        state - the state of a component
        Returns:
        true if restoration succeeds.

      • saveState

        public void saveState​(java.lang.StringBuffer buf,
                      int howMuchState,
                      int stateFlag)
        Description copied from interface: Persistable
        Saves and stores a component's state into a StringBuffer. The returned state should be HTML friendly.

        There are generally two formats of the saved state: flat state and XML representation. The minimum state is saved in flat state format, while the typical and maximum states are saved in XML string representation.

        Specified by:
        saveState in interface Persistable
        Parameters:
        buf - a StringBuffer to store the saved state.
        howMuchState - how much state information to save (EnumWebPersistableState).
        stateFlag - bit-wise flag to indicate additional information about the state (EnumWebStateFlags).
        Since:
        MicroStrategy Web 9.0.0

      • saveState

        public void saveState​(java.lang.StringBuffer buf,
                      int howMuchState)
        Description copied from interface: Persistable
        Saves and stores a component's state into a StringBuffer. The returned state should be HTML friendly.

        There are generally two formats of the saved state: flat state and XML representation. The minimum state is saved in flat state format, while the typical and maximum states are saved in XML string representation.

        Specified by:
        saveState in interface Persistable
        Parameters:
        buf - a StringBuffer to store the saved state.
        howMuchState - how much state information to save (EnumWebPersistableState).

      • restoreState

        public boolean restoreState​(SAXSupport parser,
                            java.lang.String uri,
                            java.lang.String localName,
                            java.lang.String qName,
                            org.xml.sax.Attributes attrs)
        Description copied from interface: Persistable
        Restores a component from an embedded XML during a SAX parsing.
        Specified by:
        restoreState in interface Persistable
        Parameters:
        parser - a SAX parser processing the XML representation of a state
        uri - The Namespace URI, or the empty string if the element has no Namespace URI or if Namespace processing is not being performed
        localName - The local name (without prefix), or the empty string if Namespace processing is not being performed
        qName - The qualified name (with prefix), or the empty string if qualified names are not available
        attrs - The attributes attached to the element. If there are no attributes, it shall be an empty Attributes object
        Returns:
        true to indicate a successful restoration. Otherwise, false will be returned.