java.lang.Object | ||||
↳ | com.microstrategy.utils.serialization.AbstractPersistable | |||
↳ | com.microstrategy.web.beans.AbstractTransformable | |||
↳ | com.microstrategy.web.beans.AbstractWebComponent | |||
↳ | com.microstrategy.web.beans.DerivedElementBeanImpl |
Constants | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
String | ATTRIBUTE_BEAN_HEADER | ||||||||||
String | ATT_BEAN_TYPE | ||||||||||
String | ATT_HOW_MUCH_STATE | ||||||||||
String | DATA_EXPLORER_BEAN_HEADER | ||||||||||
String | DELIMITOR | ||||||||||
String | DOCUMENT_BEAN_HEADER | ||||||||||
String | EXPRESSION_BEAN_HEADER | ||||||||||
String | FILTER_BEAN_HEADER | ||||||||||
String | FOLDER_BEAN_HEADER | ||||||||||
String | INBOX_BEAN_HEADER | ||||||||||
String | PERFORMANCE_MONITOR_BEAN_HEADER | ||||||||||
String | PROMPTDEF_BEAN_HEADER | ||||||||||
String | PROMPTS_BEAN_HEADER | ||||||||||
String | REPORT_BEAN_HEADER | ||||||||||
String | RW_BEAN_HEADER | ||||||||||
String | SEPARATOR |
[Expand]
Inherited Constants | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
![]() | |||||||||||
![]() | |||||||||||
![]() |
Fields | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
protected boolean | _hasCollectedData | A flag indicating that the XML request to collect data has been executed | |||||||||
protected int | _status |
[Expand]
Inherited Fields | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
![]() | |||||||||||
![]() |
Public Constructors | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
DerivedElementBeanImpl() |
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
void |
acceptChange()
Accepts the change that is currently being worked upon.
| ||||||||||
void | addToExclude(KeyedList elements, WebDerivedElement de) | ||||||||||
void | addToExclude(KeyedList excludeElements) | ||||||||||
boolean |
canSelectElements(WebAttribute webAttribute)
Returns true if Select Elements option can be used for the attribute
| ||||||||||
WebAttributeForm | chooseDefaultForm(WebAttribute attr) | ||||||||||
void |
collectData()
Triggers execution to the back end no matter whether it is synchronous or
asynchronous.
| ||||||||||
void |
collectMinimalData()
This is similar to
collectData() except data collected is minimal. | ||||||||||
WebElements |
excludedElements()
gets the current filter applied to the element source
| ||||||||||
boolean |
fromSearch()
Indicates that source elements are obtained from search
| ||||||||||
MarkupOutput |
generateOutput()
This is the generic method to ask the WebComponent to generate some output for the client.
| ||||||||||
WebEvent |
getAcceptListChangesEvent()
Returns the Accept List Chavnges event
| ||||||||||
WebObjectInfo |
getActiveObject()
Returns the active object, the object being qualified upon.
| ||||||||||
int |
getActiveOperatorNodeKey()
Returns the current active operator node key.
| ||||||||||
WebAttribute |
getAttribute()
Returns the attribute elements belong to.
| ||||||||||
int |
getAvailablesSourceType()
Returns the current available units source typw
| ||||||||||
int |
getDefaultStateLevel()
Returns the default state level.
| ||||||||||
KeyedList | getDerovedElements() | ||||||||||
String | getDescriptor(int key) | ||||||||||
String | getDescriptor(String key) | ||||||||||
Document |
getDocument()
Returns a
org.w3c.dom.Document parsed from the XML
representation of this bean. | ||||||||||
WebDerivedElement |
getElement()
Returns the derived element
| ||||||||||
WebElementSource |
getElementSource(WebAttribute att)
Returns properly initialized element source for a given attribute.
| ||||||||||
WebBeanError |
getErrorInfo()
Returns a
WebBeanError object indicating processing error
during the collectData method call. | ||||||||||
KeyedList | getExcludeElements() | ||||||||||
KeyedList |
getExistingDerovedElements()
Returns a collection of derived elements belonging to a given attribute.
| ||||||||||
WebExpression |
getExpression()
Returns the internal expression object.
| ||||||||||
int |
getExpressionBeanType()
Returns the expression bean type, from
EnumExpressionBeanType . | ||||||||||
int |
getExpressionEditMode()
Returns the current expression edit mode of the bean, from
EnumExpressionEditMode . | ||||||||||
Scrollable |
getIncrementalFetch()
Returns a
Scrollable interface, which can be used to set
the incremental fetch window for an attribute elements qualification. | ||||||||||
boolean |
getMatchCase()
Returns the match case flag, used in searching element browsing request.
| ||||||||||
String |
getMessageIDFromHost()
Returns message id of the report/document instance.
| ||||||||||
WebObjectInfo |
getRHS()
Returns the unit(attribute form/metric) used on the Right Hand Side(RHS) of the filter comparison
| ||||||||||
WebSessionInfo |
getSessionInfo()
Returns the
WebSessionInfo instance from this bean. | ||||||||||
boolean |
getShowAll()
Returns value of the Show All flag.
| ||||||||||
TransformInstance |
getTransformInstance(String key)
Returns the
TransformInstance object with the specified key. | ||||||||||
Enumeration |
getTransformInstances()
Retuns a
java.util.Enumeration over all the
TransformInstance objects. | ||||||||||
int |
getType()
Returns the transformable type as in
EnumWebTransformableType . | ||||||||||
String |
getUserSearchPattern()
Returns the search pattern that will be applied to any element browsing request.
| ||||||||||
WebBeanError |
getValidationErrorInfo()
This can hold a validation error which came about from the validate call.
| ||||||||||
WebWorkingSet | getWorkingSet() | ||||||||||
int |
getXMLStatus()
This method returns the
EnumRequestStatus status of the current Component. | ||||||||||
boolean | hasConstantNodes(WebNode nd) | ||||||||||
boolean |
hasTransform()
Returns a boolean value indicating whether there is a default
TransformInstance object. | ||||||||||
boolean |
hasTransform(String key)
Returns a boolean value indicating whether there is such a
TransformInstance object with the specified key. | ||||||||||
boolean |
isEditable()
Returns whether the Expression bean is editable.
| ||||||||||
boolean |
isEditable(WebNode node)
Returns whether the given node can be edited properly under the current context of the
application.
| ||||||||||
boolean |
isExpressionChanged()
Returns whether or not the expression of this derived element is changed
| ||||||||||
boolean |
isHostModified()
Returns whether or not host's derived elements is modified
| ||||||||||
boolean |
isIncFetching()
Return the flag that indicates incrementally fetching a page for the shopping cart in DE Editor
| ||||||||||
boolean |
isModified()
Returns whether this filter is modified from the filter object that it synchronizes
with.
| ||||||||||
boolean | isRA() | ||||||||||
boolean |
isStale()
Returns a boolean value indicating whether the content of this bean
is stale.
| ||||||||||
boolean | isUpdateManagerEnabled() | ||||||||||
void | populateObject(WebObjectInfo oi) | ||||||||||
void | reset() | ||||||||||
void |
resetChanges()
Undoes all changes since the last synchronize call.
| ||||||||||
void |
saveState(StringBuffer buf, int howMuchState)
Saves and stores a component's state into a
StringBuffer . | ||||||||||
String |
saveState()
Returns a
java.lang.String representaion of a component. | ||||||||||
void |
setActiveOperatorNodeKey(int _key, boolean _isNew)
Sets the current active operator node key.
| ||||||||||
void |
setAvailablesSourceType(int value)
Sets the current available source type.
| ||||||||||
void |
setContext(ExpressionBeanContext ebc)
Sets the
ExpressionBeanContext . | ||||||||||
void |
setExpressionEditMode(int _editMode)
Sets the current expression edit mode of the bean, from
EnumExpressionEditMode . | ||||||||||
void |
setHostModified(boolean isModified)
Sets the modified status of host's derived elements
| ||||||||||
void |
setIncFetching(boolean isIncFetching)
Set isIncFetching flag when incrementally fetching another page for the shopping cart in DE editor
| ||||||||||
void |
setIsEditable(boolean value)
Sets whether the expression bean is editable.
| ||||||||||
void |
setMatchCase(boolean _matchCase)
Sets the match case flag, which determines whether the user search pattern must
match case or not.
| ||||||||||
void |
setRHS(WebObjectInfo rhs)
Set the unit(attribute form/metric) used on the Right Hand Side(RHS) of the filter comparison
| ||||||||||
void |
setSessionInfo(WebSessionInfo sessionInfo)
Sets a new
WebSessionInfo instance on this bean. | ||||||||||
void |
setShowAll(boolean value)
Sets value of the Show All flag.
| ||||||||||
void |
setStale(boolean stale)
Sets a flag indicating whether this bean is stale or fresh.
| ||||||||||
void |
setUserSearchPattern(String _searchPattern)
Sets the search pattern that will be applied to any element browsing request.
| ||||||||||
void | setValidationErrorInfo(WebBeanError err) | ||||||||||
void |
setWebEventHandler(WebEventHandler handler)
Associate with this component a
WebEventHandler instance. | ||||||||||
boolean |
shallSelectElements(WebAttribute webAttribute)
This method is used to decide what Attribute subexpression to create in a given context.
| ||||||||||
void |
startEditing()
Initieats editing of the derive element
| ||||||||||
void |
synchronize()
Synchronizes any changes that have been made to this expression to the owner expression
accessible on the WebReportInstance or WebPrompt object.
| ||||||||||
void |
undoChange()
Undoes the change that is currently being worked upon.
| ||||||||||
boolean |
validate()
Attempts to perform validation on the expression.
| ||||||||||
boolean |
validateOperands(WebNode node)
Returns whether the given node and its children are valid.
|
Protected Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
void | addAttDetails(WebAttribute attr) | ||||||||||
TransformInstance |
addTransform(Transform transform, String key)
Adds a transform to itself and all the child beans which support the transform and returns a
TransformInstance of the last child bean it was added to. | ||||||||||
void | checkBeanType(AttributesXt attrs, String expected) | ||||||||||
void | checkHowMuchState(AttributesXt attrs) | ||||||||||
boolean | disableElementsBrowsing(WebAttribute att) | ||||||||||
void |
doCollectData()
Override this method in sub classes to implement the collectData method.
| ||||||||||
void | doCollectMinimalData() | ||||||||||
void | doFlatState(FlatStateSerializer serializer, int howMuchState, FlatStateTokenizer tokenizer) | ||||||||||
DerivedElementBean.Host | getHost() | ||||||||||
AbstractHandler | getStateHandler() | ||||||||||
WebObjectsFactory | getWebObjectsFactory() | ||||||||||
void |
internalCollectData(boolean collectOnError, boolean collectOnProcessing)
Overriding method should not only throw
WebBeanException , but also
sets error info if possible. | ||||||||||
void |
internalCollectData()
This method internally calls the method collectData if the method collectData has not
yet been called.
| ||||||||||
void |
internalCollectData(boolean collectOnError)
Overriding method should not only throw
WebBeanException , but also
sets error info if possible. | ||||||||||
void | invalidateAllTransformCaches() | ||||||||||
boolean |
isTransformSuitable(Transform t)
This method is called in the addTransform methods.
| ||||||||||
BeanContext |
newDefaultBeanContext()
This method is called by getBeanContext() to automatically create an instance of a BeanContext
if one has not been explicitly set.
| ||||||||||
WebEventHandler | newDefaultEventHandler() | ||||||||||
StyleRequestContext | newStyleRequestContext() | ||||||||||
void |
saveXMLState(XMLStateSerializer stateBuilder, int howMuchState)
Saves the component state
| ||||||||||
void | setEmptyListError() | ||||||||||
void | setErrorInfo(WebBeanError beanErr) | ||||||||||
void | setXMLStatus(int status) | ||||||||||
boolean | validateMetricDatatypeAllowed(WebOperatorNode activeNode) |
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
![]() | |||||||||||
![]() | |||||||||||
![]() | |||||||||||
![]() | |||||||||||
![]() | |||||||||||
![]() | |||||||||||
![]() | |||||||||||
![]() | |||||||||||
![]() | |||||||||||
![]() | |||||||||||
![]() |
A flag indicating that the XML request to collect data has been executed
Accepts the change that is currently being worked upon. The mode is set back to Default, and the active object and active operator node are set to null. This effectively makes the expression such that the undoChange method no longer does anything - it effectively means that the user accepted the single change they made.
Returns true if Select Elements option can be used for the attribute
webAttribute | attribute |
---|
WebException | |
---|---|
IndexOutOfBoundsException | |
WebBeanException | |
WebObjectsException |
Triggers execution to the back end no matter whether it is synchronous or asynchronous. If this method fails to collect data, an exception is raised and saved in a WebBeanError instance.
WebBeanException |
---|
This is similar to collectData()
except data collected is minimal. This
is essentially a check to ensure everything is ok, but that we don't need any data.
After invoking this operation, see getXMLStatus()
and getErrorInfo()
for details.
WebBeanException |
---|
Indicates that source elements are obtained from search
This is the generic method to ask the WebComponent to generate some output for the client.
The type of output should be determined by the OutputFormat property (setOutputFormat(int)
).
MarkupOutput
object.
Returns the Accept List Chavnges event
Returns the active object, the object being qualified upon. This will be null if the mode is SelectUnit or Default, or if the active operator node is set incorrectly.
Returns the current active operator node key. Note that this will not be a valid value if the mode is SelectUnit or Default.
Returns the attribute elements belong to.
Returns the current available units source typw
Returns the default state level. If not set, the default state level
is EnumWebPersistableState.MINIMAL_STATE_INFO
.
Returns a org.w3c.dom.Document
parsed from the XML
representation of this bean.
WebBeanException |
---|
Returns properly initialized element source for a given attribute.
att | attribute |
---|
Returns a WebBeanError
object indicating processing error
during the collectData
method call. Null is returned
if there is no error.
WebBeanError
object; null if there is no error.
Returns a collection of derived elements belonging to a given attribute.
Returns the internal expression object. This expression can be used to make changes to the structure of the expression.
WebExpression
representing the expression being edited.
Returns the expression bean type, from EnumExpressionBeanType
.
EnumExpressionBeanType
.
Returns the current expression edit mode of the bean, from EnumExpressionEditMode
.
This represents the current state of the bean.
EnumExpressionEditMode
.
Returns a Scrollable
interface, which can be used to set
the incremental fetch window for an attribute elements qualification.
Scrollable
object, which refers to the incremental fetch window.
Returns the match case flag, used in searching element browsing request.
Returns the unit(attribute form/metric) used on the Right Hand Side(RHS) of the filter comparison
Returns the WebSessionInfo
instance from this bean.
A WebSessionInfo
object is where you can get or set
the session ID to the intelligence server, user credentials and
localization, etc.
WebSessionInfo
instance.
Returns value of the Show All flag.
Returns the TransformInstance
object with the specified key.
key | the key of a TransformInstance . |
---|
TransformInstance
object with the specified
key.KeyDoesNotExistException |
---|
Retuns a java.util.Enumeration
over all the
TransformInstance
objects.
java.util.Enumeration
over all the
TransformInstance objects.
Returns the transformable type as in EnumWebTransformableType
.
Returns the search pattern that will be applied to any element browsing request.
This can hold a validation error which came about from the validate call.
This method returns the EnumRequestStatus
status of the current Component.
EnumRequestStatus
of the current page.
Returns a boolean value indicating whether there is a default
TransformInstance
object.
Returns a boolean value indicating whether there is such a
TransformInstance
object with the specified key.
key | the key of a Transform |
---|
TransformInstance
with the specified key.
Returns whether the Expression bean is editable.
Returns whether the given node can be edited properly under the current context of the application. If this is false, then the expression should be kept as-is in the current expression context, only allowing moving and removal of the expression. Note that this does not indicate that the subexpression is invalid; instead, it only checks whether it is possible to edit the subexpression in the current context.
node | The WebNode object which is being checked. |
---|
Returns whether or not the expression of this derived element is changed
Returns whether or not host's derived elements is modified
Return the flag that indicates incrementally fetching a page for the shopping cart in DE Editor
Returns whether this filter is modified from the filter object that it synchronizes with. For example, if the filter has changed from the base filter on the WebReportInstance object exposed on a parent Report Bean. Calling synchronize or undo will re-baseline, setting isModified back to false.
Returns a boolean value indicating whether the content of this bean is stale.
Undoes all changes since the last synchronize call. This method will ensure that the edit mode of the bean is default, and that all non-synchronized changes are undone, even if they were accepted previously via acceptChange.
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.
buf | a StringBuffer to store the saved state. |
---|---|
howMuchState | how much state information to save
(EnumWebPersistableState ). |
UnsupportedOperationException |
---|
Returns a java.lang.String
representaion of a component.
The returned state should be HTML friendly. This method call
is equivalent to call
saveState(EnumWebPersistableState.TYPICAL_STATE_INFO)
.
Sets the current active operator node key. The isNew variable must be passed in correctly - if the node is newly created, isNew should be true, if it already existed before this edit operation, it should be false. If isNew is incorrect, then the undoChange method will not work properly.
_key | The key of the current active operator node key. |
---|---|
_isNew | Whether the active operator node key is new or existing. |
Sets the current available source type.
value | value |
---|
Sets the ExpressionBeanContext
. If this is set, then the expression bean will obtain the original
expression that is being edited from that context.
ebc | The context to use to obtain the expression to be edited/displayed. |
---|
Sets the current expression edit mode of the bean, from EnumExpressionEditMode
. Note
that this operation is only valid if moving between SelectUnit and Default, or from
one node editing mode to another.
_editMode | The mode to change to, from EnumExpressionEditMode .
|
---|
Sets the modified status of host's derived elements
Set isIncFetching flag when incrementally fetching another page for the shopping cart in DE editor
Sets whether the expression bean is editable.
value | True if the expression bean should be editable, false otherwise. |
---|
Sets the match case flag, which determines whether the user search pattern must match case or not.
_matchCase | The new value of the match case flag. |
---|
Set the unit(attribute form/metric) used on the Right Hand Side(RHS) of the filter comparison
rhs | the RHS unit(attribute form/metric) |
---|
Sets a new WebSessionInfo
instance on this bean.
A WebSessionInfo
object is where you can get or set
the session ID to the intelligence server, user credentials and
localization, etc.
sessionInfo | a WebSessionInfo instance.
|
---|
IllegalArgumentException |
---|
Sets value of the Show All flag.
value | value |
---|
Sets a flag indicating whether this bean is stale or fresh.
stale | true if this bean is stale. |
---|
Sets the search pattern that will be applied to any element browsing request.
_searchPattern | The user search pattern to use for element browsing. |
---|
Associate with this component a WebEventHandler
instance.
A WebComponent has one to one relationship with a WebEventHandler instance. This method first removes any existing handler associated with this component, and then sets the new one on it.
This method calls the method setWebComponent(WebComponent)
.
Therefore, the WebEventHandler implementator should be careful
to avoid cyclic reference to each other between this component and
the event handler.
handler | the WebEventHandler instance to set. |
---|
This method is used to decide what Attribute subexpression to create in a given context. It returns true if getting list of available elements for a given attribute will be chip, for example because corresponding data set is already executed and cached.
Initieats editing of the derive element
Synchronizes any changes that have been made to this expression to the owner expression accessible on the WebReportInstance or WebPrompt object. This effectively means that the reset operation will no longer do anything, and that something should be done to the owner object to submit the synchronized expression to the Intelligence Server. Note that if this bean is not in Default mode, then what is synchronized is the version of the tree excluding the changes that were made to the active operator node. The changes to the active operator node are not lost, but are not propagated to the main expression either. This method will not change the edit mode of the bean.
Undoes the change that is currently being worked upon. If the state is Default, then nothing happens. If the state is SelectUnit, it is set back to default. Otherwise, any changes made to the active operator node or it's children since the editing operation began are undone, either by removing the active operator node (if it is new) or by rolling its state back to the state it was in when it was set as the active operator node. This will also set the mode back to default.
Attempts to perform validation on the expression. Returns false and sets the validation error (retrievable via the getValidationErrorInfo} method.
Returns whether the given node and its children are valid. The primary use of this is to ensure that the given node is valid within the given RW context.
node | The WebNode object which will be validated. If null is passed, then
the validation will start at the root. Note that all children will be validated as well. |
---|
Adds a transform to itself and all the child beans which support the transform and returns a
TransformInstance
of the last child bean it was added to.
IllegalArgumentException | |
---|---|
SAXSupportException |
Override this method in sub classes to implement the collectData method.
WebBeanException |
---|
Overriding method should not only throw WebBeanException
, but also
sets error info if possible.
collectOnError | will attempt to collect data even if object in in error. |
---|---|
collectOnProcessing | will attempt to collect data even if object is in processing. |
WebBeanException |
---|
This method internally calls the method collectData if the method collectData has not yet been called. Otherwise it does nothing.
WebBeanException |
---|
Overriding method should not only throw WebBeanException
, but also
sets error info if possible.
collectOnError | will attempt to collect data even if object in in error. |
---|
WebBeanException |
---|
This method is called in the addTransform methods. It verifies that the passed transform is suitable for this object. Default implementation simply calls transform's supports method.
This method is called by getBeanContext() to automatically create an instance of a BeanContext if one has not been explicitly set.
Saves the component state
stateBuilder | a XMLStateSerializer object |
---|---|
howMuchState | how much state to save (EnumWebPersistableState )
|