java.lang.Object
   ↳ com.microstrategy.utils.serialization.AbstractPersistable
     ↳ com.microstrategy.web.objects.WebDerivedElementsHelper

Class Overview

A helper class for Derived Elements.

Summary

Nested Classes
class WebDerivedElementsHelper.Operator  
[Expand]
Inherited Constants
From interface com.microstrategy.utils.serialization.EnumWebPersistableState
From interface com.microstrategy.web.objects.EnumWebObjectsFeatures
From interface com.microstrategy.webapi.EnumDSSXMLAccessRightFlags
Fields
public static final Operator[] operators
Public Constructors
WebDerivedElementsHelper(WebObjectsFactory fact, KeyedList el)
Constructor
Public Methods
Object _getObKey()
void addDetails(boolean details)
This method will add or remove details from the display unit.
void applyVisitor(DisplayUnitsVisitor visitor, boolean deep)
void buildShortObjectAttributes(WebXMLBuilder builder)
void buildShortXML(WebXMLBuilder builder)
boolean canHighlight()
static void customSort(RWInstance rwi, String jsonStr)
static void customSort(WebReportInstance ri, String jsonStr)
boolean equals(Object otherObject)
boolean equals(WebObjectInfo otherOI)
String getAbbreviation()
Returns the abbreviation of this object.
int getAccessGranted()
Returns the current access granted on this object, if available.
SimpleList getAncestors()
Returns a SimpleList containing the ancestors of this object, if they exist in the object XML.
WebDisplayUnits getChildUnits()
Returns the collection of child display units, or null if the object is not a collection.
String[] getComments()
Returns an array of strings, each of which represent a 'comment', that is saved as the long description of the object.
String getContainerDid()
String getContainerType()
String getCreationTime()
Returns the creation time of this object, if that information is available.
static int getCurrentFunction(DerivedElementBean myBean)
static WebDerivedElementsHelper.Operator getCurrentOperator(DerivedElementBean myBean)
String getDataSources()
String getDescription()
Returns the description of the object.
String getDisplayName()
Returns the display name associated with this object.
int getDisplayUnitType()
Returns the type of display unit that this object represents.
String getDisplayXML()
int getExtendedType()
The current extended type
WebObjectsFactory getFactory()
Returns WebObjectsFactory
int getFlags()
Returns the flags which determine what data to populate upon calling populate.
String getID()
Returns the DSS ID of the display unit.
String getIconPath()
Return the icon path for the object
String getModificationTime()
Returns the last modification time of the object, if that information is available.
long getModificationTimeStamp()
String getName()
Returns the name of this object.
boolean getNonSchedulable()
Get flag of whether the object is not schedulable
int getOtherNameTransCount()
Returns the count of name translations for locales other than the current effective locale.
WebObjectInfo getOwner()
Returns a WebObjectInfo object which corresponds to the owner of this object.
WebFolder getParent()
Returns the parent folder of the current object, if it exists.
WebPromptInstances getPromptInstances()
Returns a collection of prompt instances from this prompt site.
int getPropertyFlags()
Retrieve the current property flags
SimpleList getPropertySetFilter()
Returns an editable SimpleList where you can specify the list of propertySets that the getPropertySets call should be limited to Note that this filter is not retained in the state.
WebPropertyGroup getPropertySets()
Returns the property sets associated with this object.
WebObjectSecurity getSecurity()
Returns the WebObjectSecurity object associated with this WebObjectInfo object.
int getSelectedCount()
int getState()
Returns the state of the object.
int getSubType()
Returns the subtype of the object.
int getType()
Returns the type of this object.
String getVersionID()
Returns the Version ID of the object, if one exists.
WebViewMediaSettings getViewMediaSettings()
int getVisualizationViewMode()
String getXML(boolean encode)
Returns the XML representation of this object.
String getXML()
Returns the XML representation of this object.
boolean hasDetails()
Returns whether this display unit currently has details enabled.
boolean hasOwner()
int hashCode()
void highlightUnit(boolean details)
Sets this display unit to be highlighted.
void highlightUnit()
Sets this display unit to be highlighted.
boolean isAncestorNamedFolder(int folderName)
Returns whether the named folder is this object's ancestor.
boolean isDirty()
Returns whether this object has been modified to be different from the object in metadata.
boolean isEmbedded()
boolean isFeatureAvailable(String feature)
Returns whether the given feature is available or not.
boolean isFeatureAvailable(String feature, Object dependencyObject)
Returns whether the given feature is available or not.
boolean isHidden()
Returns whether the object is a hidden object.
boolean isHighlighted()
Returns whether this unit is highlighted.
boolean isNew()
Returns whether this object is newly created at client side, which is not in the metadata.
boolean isObjectInfo()
Returns true if underlying Web Object can be cast to WebObjectInfo.
boolean isPopulated()
Returns true if this object has been populated with its' definition from the Intelligence Server, false if it has not been populated.
boolean isSelected()
Returns whether this display unit is selected.
static boolean isSimpleExpression(DerivedElementBean myBean)
WebDerivedElement newDerivedElement(int type, WebAttribute att)
Creates a new derived element
WebDerivedElement newDerivedElement(int type, String id, WebAttribute att)
void populate()
Populates the fields on this object by asking the Intelligence Server for the object definition.
void populate(String xml)
Populates the fields on this object by loading the given object definition XML.
void restoreState(SAXSupport parser)
Restores state
String saveState(int howMuchState)
Saves state
void setAbbreviation(String ab)
void setComments(String[] _comments)
Set the long description of the object as an array of strings.
void setDataSources(String dsXML)
void setDescription(String _description)
Sets the description of the object.
void setDisplayName(String _displayName)
This method will set the value of the display name.
void setExtendedType(int extendedType)
Set the current extended type
void setFlags(int _flags)
Sets the flags which determine what data to populate upon calling populate.
void setHidden(boolean hid)
Sets whether the object is a hidden object.
void setIconPath(String iconPath)
Set the icon path for the object
void setName(String _name)
void setNonSchedulable(boolean non_schedulable)
Set flag of whether the object is not schedulable
void setPropertyFlags(int flags)
Set the current property flags
void setSelected(boolean selected)
Sets the current unit's selection status.
String toString()
Protected Methods
boolean checkAccessFlags(int flags)
boolean checkAccessRights(String feature)
boolean checkPrivilege(String feature)
boolean clearDependents()
WebOIDOMHandler createDOMHandler()
WebOIDisplayXMLHandler createDisplayXMLHandler()
WebOISAXParser createSAXParser()
WebOIXMLBuilder createXMLBuilder()
void doFlatState(FlatStateSerializer serializer, int howMuchState, FlatStateTokenizer tokenizer)
String getExtParams()
String getXMLForSave()
void handleOiBody(SAXSupport parser, String local, Attributes attrs)
void handleOiEnd(SAXSupport parser, String local, String buf)
boolean isBodyDirty()
boolean performIncrFetchLocally()
Returns whether the incremental fetch for objects should be performed locally (on the web server tier) or not.
void postProcessOi(WebObjectInfoImpl obj, SAXSupport parser, AttributesXt attrs)
void saveXMLState(WebXMLBuilder builder, int howMuchState)
void saveXMLState(StringBuffer buf, int howMuchState)
[Expand]
Inherited Methods
From class com.microstrategy.utils.serialization.AbstractPersistable
From class java.lang.Object
From interface com.microstrategy.utils.KeyedObject
From interface com.microstrategy.utils.serialization.Persistable
From interface com.microstrategy.web.objects.WebDisplayUnit
From interface com.microstrategy.web.objects.WebFeatures
From interface com.microstrategy.web.objects.WebObjectInfo
From interface com.microstrategy.web.objects.WebPromptSite

Fields

public static final Operator[] operators

Public Constructors

public WebDerivedElementsHelper (WebObjectsFactory fact, KeyedList el)

Constructor

Parameters
fact WebObjectsFactory
el a collection of Derived Elements

Public Methods

public Object _getObKey ()

public void addDetails (boolean details)

This method will add or remove details from the display unit. Note that this call may generate a call to the Intelligence Server if the details are not already present for the display unit.

Parameters
details The desired state of details for the display unit.
Throws
WebObjectsException

public void applyVisitor (DisplayUnitsVisitor visitor, boolean deep)

Throws
WebObjectsException

public void buildShortObjectAttributes (WebXMLBuilder builder)

public void buildShortXML (WebXMLBuilder builder)

public boolean canHighlight ()

public static void customSort (RWInstance rwi, String jsonStr)

Throws
WebObjectsException

public static void customSort (WebReportInstance ri, String jsonStr)

Throws
WebObjectsException

public boolean equals (Object otherObject)

public boolean equals (WebObjectInfo otherOI)

public String getAbbreviation ()

Returns the abbreviation of this object.

Returns
  • The object's abbreviation, if one exists.

public int getAccessGranted ()

Returns the current access granted on this object, if available. This comes from the bitwise or(|) of values from EnumDSSXMLAccessRightFlags.

Returns
  • The numeric representation of the access this user has to the object.

public SimpleList getAncestors ()

Returns a SimpleList containing the ancestors of this object, if they exist in the object XML. If they do not exist in object XML, and this is object has a valid DSSID, a request will be sent back to Intelligence Server to retrieve the ancestors information. These objects will be in order from highest ancestor (usually the root folder) to lowest ancestor (the parent folder).

Returns
  • A SimpleList containing the ancestors of the object.
Throws
UnsupportedOperationException

public WebDisplayUnits getChildUnits ()

Returns the collection of child display units, or null if the object is not a collection. Note that several display units are actually collections of display units as well.

Returns
  • The collection of child display units of this instance, or null if this object is not a collection.
Throws
WebObjectsException

public String[] getComments ()

Returns an array of strings, each of which represent a 'comment', that is saved as the long description of the object. These comments can be set programmatically or using MicroStrategy Desktop (Properties editor -> Long description tab) and are separated by a carriage return.

Returns
  • String array of comments

public String getContainerDid ()

public String getContainerType ()

public String getCreationTime ()

Returns the creation time of this object, if that information is available.

Returns
  • A string representing the creation time of this object.

public static int getCurrentFunction (DerivedElementBean myBean)

public static WebDerivedElementsHelper.Operator getCurrentOperator (DerivedElementBean myBean)

public String getDataSources ()

public String getDescription ()

Returns the description of the object.

Returns
  • The current description of this object.

public String getDisplayName ()

Returns the display name associated with this object. If this was not set by the user or found in the object XML, then this will be equivalent to the name property of the underlying object.

Returns
  • The display name associated with the display unit object.

public int getDisplayUnitType ()

Returns the type of display unit that this object represents. If this display unit represents a first-class object, then this method will return a value from EnumDSSXMLObjectTypes; otherwise, it will return a value from EnumWebDependentObjectType.

Returns

public String getDisplayXML ()

Throws
WebObjectsException

public int getExtendedType ()

The current extended type

Returns

public WebObjectsFactory getFactory ()

Returns WebObjectsFactory

Returns
  • WebObjectsFactory

public int getFlags ()

Returns the flags which determine what data to populate upon calling populate. This value is the bitwise or(|) of values from EnumDSSXMLObjectFlags.

Returns
  • The currently set flags value.

public String getID ()

Returns the DSS ID of the display unit.

Returns
  • The ID of the display unit.

public String getIconPath ()

Return the icon path for the object

Returns
  • String containing the icon path for the object

public String getModificationTime ()

Returns the last modification time of the object, if that information is available.

Returns
  • A string representing the last modification time of the object.

public long getModificationTimeStamp ()

public String getName ()

Returns the name of this object. the name retrieved with this method is read-only on this interface, comes from the MetaData name of a first-class object. If you wish to change the name displayed to the screen, setDisplayName(String) should be used along with the getDisplayName() call. Please also note that while only first-class objects (i.e. WebObjectInfo) has a "name" property, many object types (WebElements, and WebDimtyUnit) can have their respective "names" accessed or changed on the screen via getDisplayName() and setDisplayName(String). If you want to change the object's actual metadata name, it can be done via the appropriate save(WebObjectInfo, String) or save(WebObjectInfo, String, WebFolder) calls.

Returns
  • The name of the object.

public boolean getNonSchedulable ()

Get flag of whether the object is not schedulable

Returns
  • whether the object is not schedulable

public int getOtherNameTransCount ()

Returns the count of name translations for locales other than the current effective locale.

Returns
  • The count of name translations for locales other than the current effective locale.

public WebObjectInfo getOwner ()

Returns a WebObjectInfo object which corresponds to the owner of this object.

Returns
  • A WebObjectInfo object, representing the owner of this object
Throws
WebObjectsException

public WebFolder getParent ()

Returns the parent folder of the current object, if it exists. Note that the WebFolder object returned will not be automatically populated.

Returns
  • The parent folder of the current object. If this is the root folder, then this method will return null.
Throws
UnsupportedOperationException

public WebPromptInstances getPromptInstances ()

Returns a collection of prompt instances from this prompt site.

Returns
  • a collection of prompt instances.

public int getPropertyFlags ()

Retrieve the current property flags

Returns

public SimpleList getPropertySetFilter ()

Returns an editable SimpleList where you can specify the list of propertySets that the getPropertySets call should be limited to Note that this filter is not retained in the state. Also, once the filter is defined and propertySets are retrieved for an instance, there is no way to retrieve a different set of propertySets

public WebPropertyGroup getPropertySets ()

Returns the property sets associated with this object. Note that this will generally only work with a non-embedded (i.e. standalone) object.

Returns
  • A WebPropertyGroup object, which contains the property sets associated with this object.
Throws
WebObjectsException

public WebObjectSecurity getSecurity ()

Returns the WebObjectSecurity object associated with this WebObjectInfo object. The WebObjectSecurity interfaces allows viewing and modification of the ACL of this object, and the ability to take ownership of the object.

Returns

public int getSelectedCount ()

Throws
WebObjectsException

public int getState ()

Returns the state of the object. This value comes from EnumDSSXMLObjectState.

Returns
  • The state of this object.

public int getSubType ()

Returns the subtype of the object. This will be a value from EnumDSSXMLObjectSubTypes.

Returns
  • The subtype of the object.

public int getType ()

Returns the type of this object. This will be a value from EnumDSSXMLObjectTypes.

Returns
  • The type of the object.

public String getVersionID ()

Returns the Version ID of the object, if one exists.

Returns
  • A String representing the ID of the object version.

public WebViewMediaSettings getViewMediaSettings ()

public int getVisualizationViewMode ()

public String getXML (boolean encode)

Returns the XML representation of this object. Note that if this object has not been populated, this method will return an XML shell. The encoding parameter will tell whether the XML generated should have special characters HTML encoded.

Parameters
encode If this is true, then the returned string will have all special characters HTML-encoded.
Returns
  • The XML representation of the current state of this object.

public String getXML ()

Returns the XML representation of this object. Note that if this object has not been populated, this method will return an XML shell.

Returns
  • The XML representation of the current state of this object.

public boolean hasDetails ()

Returns whether this display unit currently has details enabled.

Returns
  • True if details are enabled, false otherwise.

public boolean hasOwner ()

public int hashCode ()

public void highlightUnit (boolean details)

Sets this display unit to be highlighted. The details value will determine whether it should include details as well.

Parameters
details Whether the highlighted unit should include details.
Throws
WebObjectsException

public void highlightUnit ()

Sets this display unit to be highlighted. This call will ensure that details are not present for the highlighted unit.

public boolean isAncestorNamedFolder (int folderName)

Returns whether the named folder is this object's ancestor.

Parameters
folderName An Enumeration in EnumDSSXMLFolderNames
Returns
  • true if the named folder in the ancestor list, false otherwise.
Throws
WebObjectsException
UnsupportedOperationException

public boolean isDirty ()

Returns whether this object has been modified to be different from the object in metadata. Any changes to this object self or the objects it contains will make this flag to be true. For a modified object, after saving it back to metadata will make this flag to be false.

Returns
  • boolean true returned when this object has been modified at client side. false returned when this object is the same as in metadata.

public boolean isEmbedded ()

public boolean isFeatureAvailable (String feature)

Returns whether the given feature is available or not.

Parameters
feature The feature to check for, from EnumWebObjectsFeatures.
Returns
  • Whether the given feature is available.

public boolean isFeatureAvailable (String feature, Object dependencyObject)

Returns whether the given feature is available or not.

Parameters
feature The feature to check for, from EnumWebObjectsFeatures.
dependencyObject A dependency object which can be used as an additional parameter for certain feature types.
Returns
  • Whether the given feature is available.

public boolean isHidden ()

Returns whether the object is a hidden object.

Returns
  • True if the object is a hidden object in metadata, false if it is not.

public boolean isHighlighted ()

Returns whether this unit is highlighted.

Returns
  • True if the display unit is highlighted, false otherwise.

public boolean isNew ()

Returns whether this object is newly created at client side, which is not in the metadata. For a new object, after saving it back to metadata will turn this flag to false.

Returns
  • boolean true returned when this is a newly created object at client side. false returned when this object is persisted in metadata.

public boolean isObjectInfo ()

Returns true if underlying Web Object can be cast to WebObjectInfo. If an object can be cast to WebObjectInfo, then it is a first class object.

Returns

public boolean isPopulated ()

Returns true if this object has been populated with its' definition from the Intelligence Server, false if it has not been populated.

Returns
  • The current population status of this object.

public boolean isSelected ()

Returns whether this display unit is selected.

Returns
  • True if the unit is selected, false otherwise.

public static boolean isSimpleExpression (DerivedElementBean myBean)

public WebDerivedElement newDerivedElement (int type, WebAttribute att)

Creates a new derived element

Parameters
att attribute a created element belongs to
Returns
  • WebDerivedElementImpl

public WebDerivedElement newDerivedElement (int type, String id, WebAttribute att)

public void populate ()

Populates the fields on this object by asking the Intelligence Server for the object definition.

Throws
WebObjectsException

public void populate (String xml)

Populates the fields on this object by loading the given object definition XML.

Parameters
xml The XML String to use to populate this object.
Throws
WebObjectsException

public void restoreState (SAXSupport parser)

Restores state

Parameters
parser SAXSupport
Throws
SAXException

public String saveState (int howMuchState)

Saves state

Parameters
howMuchState int
Returns
  • state XML

public void setAbbreviation (String ab)

public void setComments (String[] _comments)

Set the long description of the object as an array of strings. The long description is also known as the comments.

Parameters
_comments String array of comments

public void setDataSources (String dsXML)

public void setDescription (String _description)

Sets the description of the object. The object must be saved by the save or copy methods on the WebObjectSource object to cause a change to this object to be saved.

Parameters
_description The description for the object.

public void setDisplayName (String _displayName)

This method will set the value of the display name. This name will be used to identify the object in display XML. Setting this value will have no affect on the actual name of the object.

Parameters
_displayName The display name to associate with the object.

public void setExtendedType (int extendedType)

Set the current extended type

public void setFlags (int _flags)

Sets the flags which determine what data to populate upon calling populate. This value should be the bitwise or(|) of values from EnumDSSXMLObjectFlags.

Parameters
_flags The flags value to use for object definition retrieval.

public void setHidden (boolean hid)

Sets whether the object is a hidden object. To save the change of this property to metadata, DssXmlObjectBrowser flag need to be set on WebObjectSource before calling save(WebObjectInfo) with this object as input parameter.

Parameters
hid boolean true to set this object to hidden.

public void setIconPath (String iconPath)

Set the icon path for the object

public void setName (String _name)

public void setNonSchedulable (boolean non_schedulable)

Set flag of whether the object is not schedulable

public void setPropertyFlags (int flags)

Set the current property flags

Parameters
flags int binary OR of EnumDSSXMLPropertyXmlFlags

public void setSelected (boolean selected)

Sets the current unit's selection status.

Parameters
selected Whether the unit should be set to be selected or not.

public String toString ()

Protected Methods

protected boolean checkAccessFlags (int flags)

protected boolean checkAccessRights (String feature)

protected boolean checkPrivilege (String feature)

Throws
WebObjectsException

protected boolean clearDependents ()

protected WebOIDOMHandler createDOMHandler ()

protected WebOIDisplayXMLHandler createDisplayXMLHandler ()

protected WebOISAXParser createSAXParser ()

protected WebOIXMLBuilder createXMLBuilder ()

protected void doFlatState (FlatStateSerializer serializer, int howMuchState, FlatStateTokenizer tokenizer)

protected String getExtParams ()

protected String getXMLForSave ()

protected void handleOiBody (SAXSupport parser, String local, Attributes attrs)

Throws
SAXException

protected void handleOiEnd (SAXSupport parser, String local, String buf)

protected boolean isBodyDirty ()

protected boolean performIncrFetchLocally ()

Returns whether the incremental fetch for objects should be performed locally (on the web server tier) or not.

Returns
  • True if the incremental fetch should be performed on the Web Server Tier; otherwise, false.

protected void postProcessOi (WebObjectInfoImpl obj, SAXSupport parser, AttributesXt attrs)

Throws
SAXException

protected void saveXMLState (WebXMLBuilder builder, int howMuchState)

protected void saveXMLState (StringBuffer buf, int howMuchState)