Package com.microstrategy.web.beans

Class WebBeanFactory

java.lang.Object

com.microstrategy.web.beans.AbstractLocalBeanFactory

com.microstrategy.web.beans.WebBeanFactory

All Implemented Interfaces:

EnumEventHandlerTypes, EnumWebTransformableType, LocalBeanFactory

public class WebBeanFactory
extends AbstractLocalBeanFactory
implements EnumWebTransformableType, EnumEventHandlerTypes

This class is a factory for instantiating various WebBean or other Transformable compliant objects in the com.microstrategy.web.beans package. Note that most methods on this class are deprecated; we now provide the BeanFactory class for programmatic bean creation. Please create beans using the BeanFactory instead of using this class directly.

Since:

MicroStrategy Web 7.3.1 or earlier

Field Summary

Fields inherited from interface com.microstrategy.web.beans.EnumEventHandlerTypes

HANDLER_ANNOTATION_BEAN, HANDLER_PROMPT_ANSWER, HANDLER_TYPE_ADDRESS_LIST, HANDLER_TYPE_ASSOCIATED_SCHEDULES, HANDLER_TYPE_ATTRIBUTE, HANDLER_TYPE_CONSTANT_PROMPT, HANDLER_TYPE_CUSTOMGROUP, HANDLER_TYPE_DATA_EXPLORER, HANDLER_TYPE_DIMTY_PROMPT, HANDLER_TYPE_DOCUMENT, HANDLER_TYPE_EDITABLE_OBJECT, HANDLER_TYPE_ELEMENT_PROMPT, HANDLER_TYPE_EXPRESSION, HANDLER_TYPE_EXPRESSION_PROMPT, HANDLER_TYPE_FOLDER, HANDLER_TYPE_GENERIC, HANDLER_TYPE_GROUP, HANDLER_TYPE_IMPORT_WIZARD, HANDLER_TYPE_INBOX, HANDLER_TYPE_OBJECT, HANDLER_TYPE_OBJECT_PROMPT, HANDLER_TYPE_PROMPT, HANDLER_TYPE_PROMPT_DEFINITION, HANDLER_TYPE_PROMPTS, HANDLER_TYPE_REPORT, HANDLER_TYPE_RW, HANDLER_TYPE_SCHEDULE, HANDLER_TYPE_SECURITY_FILTER, HANDLER_TYPE_SECURITY_ROLE, HANDLER_TYPE_SUBSCRIPTION, HANDLER_TYPE_SUBSCRIPTION_FOLDER, HANDLER_TYPE_THRESHOLD, HANDLER_TYPE_THRESHOLD_BEAN, HANDLER_TYPE_USER, HANDLER_TYPE_USER_ENTITIES, HANDLER_TYPE_USER_ENTITY, HANDLER_TYPE_USER_SEARCH, HANDLER_TYPE_VIEW

Fields inherited from interface com.microstrategy.web.beans.EnumWebTransformableType

WEB_BEAN_ACCOUNTCOLLECTION, WEB_BEAN_ADDRESS_LIST, WEB_BEAN_ANY, WEB_BEAN_ATTRIBUTE, WEB_BEAN_CUSTOMGROUP, WEB_BEAN_DATA_EXPLORER, WEB_BEAN_DERIVED_ELEMENT, WEB_BEAN_DOCUMENT, WEB_BEAN_EXPRESSION, WEB_BEAN_FILTER, WEB_BEAN_FILTER_EXPRESSION, WEB_BEAN_FOLDER, WEB_BEAN_GRAPH, WEB_BEAN_GROUP, WEB_BEAN_INBOX, WEB_BEAN_PERFORMANCE_MONITOR, WEB_BEAN_PROMPT, WEB_BEAN_PROMPT_DEFINITION, WEB_BEAN_PROMPTS, WEB_BEAN_REPORT, WEB_BEAN_RW, WEB_BEAN_SCHEDULE, WEB_BEAN_SECURITY_FILTER, WEB_BEAN_SECURITY_ROLE, WEB_BEAN_SUBSCRIPTION, WEB_BEAN_SUBSCRIPTION_FOLDER, WEB_BEAN_USER, WEB_BEAN_USER_SEARCH, WEB_BEAN_VIEW, WEB_NOT_TRANSFORMABLE

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	WebBeanFactory()	Constructs a WebBeanFactory with no parameter.

Method Summary

Modifier and Type	Method	Description
SecurityFilterBean	createNewSecurityFilter()	Deprecated. Call BeanFactory.newBean(java.lang.String) to create a new SecurityFilterBean, then call EditableBean.InitAsNew() on the new bean instance.
static java.lang.Class	getBeanInterface(int beanType)	Deprecated. Reference bean interface classes directly rather than calling this method.
protected java.lang.String	getBeanPackage()	Returns the full name of the package associated with this factory (ex: "com.microstrategy.web.beans").
protected WebEventHandler	getEventHandler(int type)	Deprecated. To get the default event-handler associated with a bean, create a new instance of that bean and call getWebEventHandler.
static WebBeanFactory	getInstance()	Returns a singleton of the WebBeanFactory.
AddressListBean	newAddressListBean()	Deprecated. Use BeanFactory.newBean(java.lang.String) instead.
AttributeBean	newAttributeBean()
BeanContext	newBeanContext()	Instantiates a BeanContext.
DataExplorerBean	newDataExplorerBean()	Deprecated. Use BeanFactory.newBean(java.lang.String) instead.
DocumentBean	newDocumentBean()	Deprecated. Use BeanFactory.newBean(java.lang.String) instead.
ExpressionDisplayBean	newExpressionDisplayBean()	Deprecated. Use BeanFactory.newBean(java.lang.String) instead.
ExpressionObject	newExpressionObject(WebExpression pExpression, BeanContext pContext)	Instantiates a ExpressionObject.
ExpressionObject	newExpressionObject(WebExpression pExpression, BeanContext pContext, WebWorkingSet pWorkingSet)	nstantiates a ExpressionObject.
FolderBean	newFolderBean()	Deprecated. Use BeanFactory.newBean(java.lang.String) instead.
GraphBean	newGraphBean()	Deprecated. Use BeanFactory.newBean(java.lang.String) instead.
InboxBean	newInboxBean()	Deprecated. Use BeanFactory.newBean(java.lang.String) instead.
MarkupOutput	newMarkupOutput()	Instantiates a MarkupOutput.
MarkupOutput	newMarkupOutput(boolean encode)	Instantiates a MarkupOutput.
PromptDefinitionBean	newPromptDefinitionBean()	Deprecated. Use BeanFactory.newBean(java.lang.String) instead.
PromptsBean	newPromptsBean()	Deprecated. Use BeanFactory.newBean(java.lang.String) instead.
ReportBean	newReportBean()	Deprecated. Use BeanFactory.newBean(java.lang.String) instead.
RWBean	newRWBean()	Deprecated. Use BeanFactory.newBean(java.lang.String) instead.
ScheduleBean	newScheduleBean()	Deprecated. Use BeanFactory.newBean(java.lang.String) instead.
SecurityFilterBean	newSecurityFilterBean()	Deprecated. Use BeanFactory.newBean(java.lang.String) instead.
SecurityRoleBean	newSecurityRoleBean()	Deprecated. Use BeanFactory.newBean(java.lang.String) instead.
SubscriptionBean	newSubscriptionBean()	Deprecated. Use BeanFactory.newBean(java.lang.String) instead.
SubscriptionFolderBean	newSubscriptionFolderBean()	Deprecated. Use BeanFactory.newBean(java.lang.String) instead.
ThresholdExpressionBean	newThresholdExpressionBean()	Deprecated. Use BeanFactory.newBean(java.lang.String) instead.
UserBean	newUserBean()	Deprecated. Use BeanFactory.newBean(java.lang.String) instead.
UserEntitiesBean	newUserEntitiesBean()	Deprecated. Use BeanFactory.newBean(java.lang.String) instead.
UserGroupBean	newUserGroupBean()	Deprecated. Use BeanFactory.newBean(java.lang.String) instead.
UserSearchBean	newUserSearchBean()	Deprecated. Use BeanFactory.newBean(java.lang.String) instead.
WebBean	newWebBean(int webBeanType)	Deprecated. Use BeanFactory.newBean(java.lang.String) instead.

Methods inherited from class com.microstrategy.web.beans.AbstractLocalBeanFactory

canCreateBean, createBeanInstance, getBeanClassName, newBean

Methods inherited from class java.lang.Object

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

Constructor Detail

WebBeanFactory

protected WebBeanFactory()

Constructs a WebBeanFactory with no parameter. It ensures that this factory gets never instantiated outside.

Method Detail

getEventHandler

protected WebEventHandler getEventHandler(int type)

Deprecated.

To get the default event-handler associated with a bean, create a new instance of that bean and call getWebEventHandler.

Instantiates a WebEventHandler with the specified type.

Parameters:

type - an event handler type

Returns:

an instance of event handler with the specified type

newFolderBean

public FolderBean newFolderBean()

Deprecated.

Use BeanFactory.newBean(java.lang.String) instead.

Instantiates a FolderBean.

Returns:

A new FolderBean instance.

newGraphBean

public GraphBean newGraphBean()

Deprecated.

Use BeanFactory.newBean(java.lang.String) instead.

Instantiates a FolderBean.

Returns:

A new GraphBean instance.

Since:

MicroStrategy Web 8.0.0

newReportBean

public ReportBean newReportBean()

Deprecated.

Use BeanFactory.newBean(java.lang.String) instead.

Instantiates a ReportBean.

Returns:

A new ReportBean instance.

newDataExplorerBean

public DataExplorerBean newDataExplorerBean()

Deprecated.

Use BeanFactory.newBean(java.lang.String) instead.

Instantiates a DataExplorerBean.

Returns:

A new DataExplorerBean instance.

Since:

MicroStrategy Web 9.0.0

newRWBean

public RWBean newRWBean()

Deprecated.

Use BeanFactory.newBean(java.lang.String) instead.

Returns a new RWBean.

Returns:

a new RWBean.

Since:

MicroStrategy Web 8.0.0

newPromptsBean

public PromptsBean newPromptsBean()

Deprecated.

Use BeanFactory.newBean(java.lang.String) instead.

Instantiates a PromptsBean.

Returns:

A new PromptsBean instance.

newDocumentBean

public DocumentBean newDocumentBean()

Deprecated.

Use BeanFactory.newBean(java.lang.String) instead.

Instantiates a DocumentBean.

Returns:

A new DocumentBean instance.

newMarkupOutput

public MarkupOutput newMarkupOutput()

Instantiates a MarkupOutput.

Returns:

A new MarkupOutput instance.

newMarkupOutput

public MarkupOutput newMarkupOutput(boolean encode)

Instantiates a MarkupOutput.

Parameters:

encode - a boolean indicating whether encoding is needed for the makrupOutput implementation.

Returns:

A new MarkupOutput instance.

newInboxBean

public InboxBean newInboxBean()

Deprecated.

Use BeanFactory.newBean(java.lang.String) instead.

Instantiates a InboxBean.

Returns:

A new InboxBean instance.

newAddressListBean

public AddressListBean newAddressListBean()

Deprecated.

Use BeanFactory.newBean(java.lang.String) instead.

Instantiates a AddressListBean.

Returns:

A new AddressListBean instance.

newSubscriptionBean

public SubscriptionBean newSubscriptionBean()

Deprecated.

Use BeanFactory.newBean(java.lang.String) instead.

Instantiates a SubscriptionBean.

Returns:

A new SubscriptionBean instance.

newSubscriptionFolderBean

public SubscriptionFolderBean newSubscriptionFolderBean()

Deprecated.

Use BeanFactory.newBean(java.lang.String) instead.

Instantiates a SubscriptionFolderBean.

Returns:

A new SubscriptionFolderBean instance.

newScheduleBean

public ScheduleBean newScheduleBean()

Deprecated.

Use BeanFactory.newBean(java.lang.String) instead.

Instantiates a ScheduleBean.

Returns:

A new ScheduleBean instance.

newAttributeBean

public AttributeBean newAttributeBean()

Since:

MicroStrategy Web 9.0.0

getInstance

public static WebBeanFactory getInstance()

Returns a singleton of the WebBeanFactory. This is the only entry point to gain access to various WebBean and other Transformable compliant objects.

Returns:

the singleton of this WebBeanFactory.

newWebBean

public WebBean newWebBean(int webBeanType)

Deprecated.

Use BeanFactory.newBean(java.lang.String) instead.

Instantiates a type specific WebBean with the specified bean type.

Parameters:

webBeanType - the bean type from EnumWebTransformableType

Returns:

A type specific WebBean instance.

newBeanContext

public BeanContext newBeanContext()

Instantiates a BeanContext.

Returns:

A new BeanContext instance.

newExpressionObject

public ExpressionObject newExpressionObject(WebExpression pExpression,
                                            BeanContext pContext)

Instantiates a ExpressionObject.

Parameters:

pExpression - an instance of WebExpression from where this ExpressionObject originates.

pContext - an instance of BeanContext.

Returns:

A new ExpressionObject instance.

newExpressionObject

public ExpressionObject newExpressionObject(WebExpression pExpression,
                                            BeanContext pContext,
                                            WebWorkingSet pWorkingSet)

nstantiates a ExpressionObject.

Parameters:

pExpression - an instance of WebExpression from where this ExpressionObject originates.

pContext - an instance of BeanContext.

pWorkingSet - an instance of WebWorkingSet.

Returns:

A new ExpressionObject instance.

getBeanInterface

public static java.lang.Class getBeanInterface(int beanType)

Deprecated.

Reference bean interface classes directly rather than calling this method. If you need to use reflection to get/set properties on a bean, consider using the ReflectionHelper class.

Returns the java.lang.Class object associated with each type specific WebBean.

Parameters:

beanType - the bean type of EnumWebTransformableType

Returns:

the java.lang.Class associated with each type specific WebBean.

newUserGroupBean

public UserGroupBean newUserGroupBean()

Deprecated.

Use BeanFactory.newBean(java.lang.String) instead.

Returns a new UserGroupBean.

Returns:

a new UserGroupBean.

Since:

MicroStrategy Web 8.0.0

newUserEntitiesBean

public UserEntitiesBean newUserEntitiesBean()

Deprecated.

Use BeanFactory.newBean(java.lang.String) instead.

Returns a new UserEntitiesBean.

Returns:

a new UserEntitiesBean.

Since:

MicroStrategy Web 8.0.0

newUserSearchBean

public UserSearchBean newUserSearchBean()

Deprecated.

Use BeanFactory.newBean(java.lang.String) instead.

Returns a new UserSearchBean.

Returns:

a new UserSearchBean.

Since:

MicroStrategy Web 8.0.0

newUserBean

public UserBean newUserBean()

Deprecated.

Use BeanFactory.newBean(java.lang.String) instead.

Returns a new UserBean.

Returns:

a new UserBean.

Since:

MicroStrategy Web 7.5.2

newSecurityFilterBean

public SecurityFilterBean newSecurityFilterBean()

Deprecated.

Use BeanFactory.newBean(java.lang.String) instead.

Since:

MicroStrategy Web 8.0.1

createNewSecurityFilter

public SecurityFilterBean createNewSecurityFilter()

Deprecated.

Call BeanFactory.newBean(java.lang.String) to create a new SecurityFilterBean, then call EditableBean.InitAsNew() on the new bean instance.

Since:

MicroStrategy Web 8.0.1

newPromptDefinitionBean

public PromptDefinitionBean newPromptDefinitionBean()

Deprecated.

Use BeanFactory.newBean(java.lang.String) instead.

Since:

MicroStrategy Web 9.0.0

newSecurityRoleBean

public SecurityRoleBean newSecurityRoleBean()

Deprecated.

Use BeanFactory.newBean(java.lang.String) instead.

Since:

MicroStrategy Web 9.0.0

getBeanPackage

protected java.lang.String getBeanPackage()

Description copied from class: AbstractLocalBeanFactory

Returns the full name of the package associated with this factory (ex: "com.microstrategy.web.beans").

Specified by:

getBeanPackage in class AbstractLocalBeanFactory

Returns:

The name of the package associated with this factory.

Since:

MicroStrategy Web 9.0.0

newExpressionDisplayBean

public ExpressionDisplayBean newExpressionDisplayBean()

Deprecated.

Use BeanFactory.newBean(java.lang.String) instead.

Since:

MicroStrategy Web 9.0.0

newThresholdExpressionBean

public ThresholdExpressionBean newThresholdExpressionBean()

Deprecated.

Use BeanFactory.newBean(java.lang.String) instead.

Since:

MicroStrategy Web 9.0.0