public abstract class

AbstractPersistable

extends Object
implements Persistable
java.lang.Object
   ↳ com.microstrategy.utils.serialization.AbstractPersistable
Known Direct Subclasses
Known Indirect Subclasses

Class Overview

Base class that provides facilities to save and restore states.

Summary

[Expand]
Inherited Constants
From interface com.microstrategy.utils.serialization.EnumWebPersistableState
Fields
protected ScriptVariableJSONEncoder scriptEndTagEncoder reference to encoder that deals with tag encoding
Public Constructors
AbstractPersistable()
Public Methods
boolean restoreState(SAXSupport parser, String uri, String localName, String qName, Attributes attrs)
Restores a component from an embedded XML during a SAX parsing.
boolean restoreState(String state)
Restores a component based on its saved state.
String saveState()
Returns a java.lang.String representation of a component.
void saveState(StringBuffer buf, int howMuchState, int stateFlag)
Saves and stores a component's state into a StringBuffer.
void saveState(StringBuffer buf, int howMuchState)
Saves and stores a component's state into a StringBuffer.
String saveState(int howMuchState)
Returns a java.lang.String representation of a component.
Protected Methods
void doFlatState(FlatStateSerializer ser, int howMuchState, FlatStateTokenizer tok, int stateFlag)
void doFlatState(FlatStateSerializer ser, int howMuchState, FlatStateTokenizer tok)
AbstractHandler getStateHandler()
boolean isXMLStateZipped()
void restoreXMLState(String state)
void saveXMLState(StringBuffer buf, int howMuchState, int stateFlag)
void saveXMLState(StringBuffer buf, int howMuchState)
[Expand]
Inherited Methods
From class java.lang.Object
From interface com.microstrategy.utils.serialization.Persistable

Fields

protected ScriptVariableJSONEncoder scriptEndTagEncoder

reference to encoder that deals with tag encoding

Public Constructors

public AbstractPersistable ()

Public Methods

public boolean restoreState (SAXSupport parser, String uri, String localName, String qName, Attributes attrs)

Restores a component from an embedded XML during a SAX parsing.

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.

public boolean restoreState (String state)

Restores a component based on its saved state.

Parameters
state the state of a component
Returns
  • true if restoration succeeds.

public String saveState ()

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).

Returns
  • the serialized state of a component.

public void saveState (StringBuffer buf, int howMuchState, int stateFlag)

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.

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).
Throws
UnsupportedOperationException

public void saveState (StringBuffer buf, int howMuchState)

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.

Parameters
buf a StringBuffer to store the saved state.
howMuchState how much state information to save (EnumWebPersistableState).
Throws
UnsupportedOperationException

public String saveState (int howMuchState)

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).

Parameters
howMuchState how much state information to save (EnumWebPersistableState).
Returns
  • the serialized state of a component.

Protected Methods

protected void doFlatState (FlatStateSerializer ser, int howMuchState, FlatStateTokenizer tok, int stateFlag)

protected void doFlatState (FlatStateSerializer ser, int howMuchState, FlatStateTokenizer tok)

protected AbstractHandler getStateHandler ()

Throws
UnsupportedOperationException

protected boolean isXMLStateZipped ()

protected void restoreXMLState (String state)

Throws
SAXException

protected void saveXMLState (StringBuffer buf, int howMuchState, int stateFlag)

protected void saveXMLState (StringBuffer buf, int howMuchState)