Package com.microstrategy.web.blocks.config

Class BlockConfig

java.lang.Object

com.microstrategy.utils.config.AbstractConfigurationElement

com.microstrategy.web.blocks.config.BlockConfig

All Implemented Interfaces:

ConfigurationElement, ConfigurationFile, java.lang.Cloneable

public class BlockConfig
extends AbstractConfigurationElement

THIS CLASS IS NOT SUPPORTED FOR USE IN CUSTOM APPLICATION DEVELOPMENT. THE CLASS IS SUBJECT TO CHANGE IN FUTURE RELEASES AND SOME METHODS AND PROPERTIES MAY NOT BE SUITABLE FOR CUSTOM DEVELOPMENT.

Since:

MicroStrategy Web 9.0.0

Nested Class Summary

Nested classes/interfaces inherited from class com.microstrategy.utils.config.AbstractConfigurationElement

AbstractConfigurationElement.FilteredList

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	ATT_ANNOTATION
static java.lang.String	ATT_BLOCK_NAME
static java.lang.String	ATT_INHERITS
static java.lang.String	ATT_LISTACTION
static java.lang.String	ATT_LISTELEMKEY
static java.lang.String	ATT_LISTITEM
static java.lang.String	NODE_BLOCK

Fields inherited from class com.microstrategy.utils.config.AbstractConfigurationElement

ATT_CONFIG_SRC, ATT_DELETED, ATT_POSITION, ATT_PROTOTYPE, ATT_USE_DEFAULT

Constructor Summary

Constructors

Constructor	Description
BlockConfig()
BlockConfig(java.lang.String name)
BlockConfig(org.w3c.dom.Node root)	Constructor that takes a Node parameter.

Method Summary

Modifier and Type	Method	Description
void	addProperty(Property property)
java.lang.String	getAnnotation()
Assignments	getAssignment(java.lang.String mode)
java.util.List<Assignments>	getAssignments()
Definition	getDefinition()
java.util.List<java.lang.String>	getDependentBlockNames()
protected java.lang.String	getDTDFileName()	Returns the name of a DTD file that will be added as SystemID to the XML resulting from serializing the contents of this ConfigurationElement into a file; null by default.
java.lang.String	getInherits()
java.lang.Object	getKey()	Default implementation for getKey().
protected java.lang.String	getKeyAttribute()	This method must return the attribute that uniquely identifies this element among its siblings; if no single attribute can be used, return null and override the getKey and setKey methods.
java.lang.String	getListAction()
java.lang.String	getListElementKey()
java.lang.String	getListItem()
java.lang.String	getName()
java.util.List<Property>	getProperties()
Property	getProperty(java.lang.Object propertyName)
protected boolean	isKeyAttribute(java.lang.String name)	Returns true is the name is that of the key attribute.
void	setAnnotation(java.lang.String annotation)
void	setAssignment(Assignments assignment)
void	setDefiniton(Definition definition)
void	setInherits(java.lang.String inherits)
void	setInitPath(java.lang.String path)	This method is used only if a new Element is created programmatically using the conifguration editor.
void	setListAction(java.lang.String action)
void	setListElementKey(java.lang.String key)
void	setListItem(java.lang.String item)
void	setName(java.lang.String name)

Methods inherited from class com.microstrategy.utils.config.AbstractConfigurationElement

addFileSource, applyCustomization, applyCustomizations, cleanUpDeletedElements, clone, delete, deltas, deltas, equalAtts, equalElements, equalNodeValues, equals, equalsIncludingDeletedElements, exportAttributesToXML, exportElementsToXML, exportNodeValueToXML, getAttribute, getAttributes, getBoolAttribute, getChildKey, getConfigSrc, getElement, getElement, getElements, getFileLoader, getIntAttribute, getIntAttribute, getLineNumber, getList, getNextKey, getNodeName, getNodeValue, getNodeValue, getOrCreateElement, getParent, getPosition, getPrototype, getRegisteredClass, getSelfInitPath, getSource, getStrAttribute, getUseDefault, getXMLParserParameters, getXMLSerializerParameters, hashCode, hashCodeAtts, hashCodeElements, hashCodeNodeValues, hasRegisteredClass, initAttributesFromXML, initDefaultAttributes, initElementFromXML, initElementsFromXML, initFromFile, initFromResource, initFromXML, initFromXML, initNodeValueFromXML, initPrototype, isActive, isCustomized, isDeleted, isDirty, isInSource, load, mergeChanges, newChildInstance, newSource, original, populate, printAttributes, printElements, printNodeValue, refreshLists, registerClass, registerElement, registerElement, registerElementList, reload, reloadPrototype, removeAttribute, removeDefaults, replaceList, restore, save, save, saveChangesAs, saveConfig, saveFlatXML, saveNode, saveSource, setAttribute, setBoolAttribute, setChildOriginals, setConfigSrc, setCustomized, setElement, setFileLoader, setIntAttribute, setKey, setLineNumber, setNodeName, setNodeValue, setPosition, setPrototype, setSelfInitPath, setStrAttribute, setUseDefault, setUseValidation, throwConfigParseException, toString, toXML, toXML, toXML, toXML, useNodeValue, useValidation

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

NODE_BLOCK

public static final java.lang.String NODE_BLOCK

See Also:

Constant Field Values

ATT_BLOCK_NAME

public static final java.lang.String ATT_BLOCK_NAME

See Also:

Constant Field Values

ATT_INHERITS

public static final java.lang.String ATT_INHERITS

See Also:

Constant Field Values

ATT_LISTELEMKEY

public static final java.lang.String ATT_LISTELEMKEY

See Also:

Constant Field Values

ATT_LISTITEM

public static final java.lang.String ATT_LISTITEM

See Also:

Constant Field Values

ATT_LISTACTION

public static final java.lang.String ATT_LISTACTION

See Also:

Constant Field Values

ATT_ANNOTATION

public static final java.lang.String ATT_ANNOTATION

See Also:

Constant Field Values

Constructor Detail

BlockConfig

public BlockConfig()

BlockConfig

public BlockConfig(java.lang.String name)

BlockConfig

public BlockConfig(org.w3c.dom.Node root)

Constructor that takes a Node parameter.

Parameters:

root - The root node.

Since:

MicroStrategy Web 9.0.1

Method Detail

getName

public java.lang.String getName()

getInherits

public java.lang.String getInherits()

getAnnotation

public java.lang.String getAnnotation()

getListElementKey

public java.lang.String getListElementKey()

getListItem

public java.lang.String getListItem()

getListAction

public java.lang.String getListAction()

setName

public void setName(java.lang.String name)

setInherits

public void setInherits(java.lang.String inherits)

setAnnotation

public void setAnnotation(java.lang.String annotation)

setListElementKey

public void setListElementKey(java.lang.String key)

setListItem

public void setListItem(java.lang.String item)

setListAction

public void setListAction(java.lang.String action)

getDefinition

public Definition getDefinition()

getAssignments

public java.util.List<Assignments> getAssignments()

getAssignment

public Assignments getAssignment(java.lang.String mode)

setAssignment

public void setAssignment(Assignments assignment)

getProperties

public java.util.List<Property> getProperties()

getProperty

public Property getProperty(java.lang.Object propertyName)

getDependentBlockNames

public java.util.List<java.lang.String> getDependentBlockNames()

getKeyAttribute

protected java.lang.String getKeyAttribute()

Description copied from class: AbstractConfigurationElement

This method must return the attribute that uniquely identifies this element among its siblings; if no single attribute can be used, return null and override the getKey and setKey methods.

Specified by:

getKeyAttribute in class AbstractConfigurationElement

getDTDFileName

protected java.lang.String getDTDFileName()

Description copied from class: AbstractConfigurationElement

Returns the name of a DTD file that will be added as SystemID to the XML resulting from serializing the contents of this ConfigurationElement into a file; null by default. This method should be extended if the concrete instance of an element has a predefined DTD file associated.

Overrides:

getDTDFileName in class AbstractConfigurationElement

getKey

public java.lang.Object getKey()

Description copied from class: AbstractConfigurationElement

Default implementation for getKey(). It assumes a single attribute can be used to uniquely identify this element among its siblings; the attribute to use is specified by the getKeyAttribute() method.

Specified by:

getKey in interface ConfigurationElement

Overrides:

getKey in class AbstractConfigurationElement

Returns:

If getKeyAttribute() is empty returns null, otherwise it returns the value of the given attribute.

isKeyAttribute

protected boolean isKeyAttribute(java.lang.String name)

Description copied from class: AbstractConfigurationElement

Returns true is the name is that of the key attribute.

Overrides:

isKeyAttribute in class AbstractConfigurationElement

Since:

MicroStrategy Web 9.0.1

setDefiniton

public void setDefiniton(Definition definition)

addProperty

public void addProperty(Property property)

setInitPath

public void setInitPath(java.lang.String path)

This method is used only if a new Element is created programmatically using the conifguration editor.

Parameters:

path - The path for newly created BlockConfig

Since:

MicroStrategy Web 9.0.1