Class Property
- java.lang.Object
-
- com.microstrategy.utils.config.AbstractConfigurationElement
-
- com.microstrategy.web.blocks.config.Property
-
- All Implemented Interfaces:
ConfigurationElement
,ConfigurationFile
,java.lang.Cloneable
public class Property 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
NODE_PROPERTY
-
Fields inherited from class com.microstrategy.utils.config.AbstractConfigurationElement
ATT_CONFIG_SRC, ATT_DELETED, ATT_POSITION, ATT_PROTOTYPE, ATT_USE_DEFAULT
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addBlockConfig(BlockConfig blockConfig)
void
addBlockListConfig(BlockListConfig blockListConfig)
java.lang.String
getAnnotation()
BlockConfig
getBlockConfig()
BlockListConfig
getBlockListConfig()
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 thegetKey
andsetKey
methods.java.lang.String
getName()
java.lang.String
getType()
protected void
initElementsFromXML(org.w3c.dom.Node root, java.lang.String sourceKey, CustomizationInfo c)
Initializes the list of child-elements from givenNode
void
setAnnotation(java.lang.String annotation)
void
setName(java.lang.String name)
protected void
setNodeValue(java.lang.String value)
Returns the node value for this element.void
setPropertyValue(java.lang.String propertyValue)
void
setType(java.lang.String type)
protected boolean
useNodeValue()
Controls whether this element will use the node value as a property.-
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, getDTDFileName, getElement, getElement, getElements, getFileLoader, getIntAttribute, getIntAttribute, getKey, 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, initFromFile, initFromResource, initFromXML, initFromXML, initNodeValueFromXML, initPrototype, isActive, isCustomized, isDeleted, isDirty, isInSource, isKeyAttribute, 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, setPosition, setPrototype, setSelfInitPath, setStrAttribute, setUseDefault, setUseValidation, throwConfigParseException, toString, toXML, toXML, toXML, toXML, useValidation
-
-
-
-
Field Detail
-
NODE_PROPERTY
public static final java.lang.String NODE_PROPERTY
- See Also:
- Constant Field Values
-
-
Method Detail
-
getName
public java.lang.String getName()
-
getType
public java.lang.String getType()
-
getAnnotation
public java.lang.String getAnnotation()
-
setName
public void setName(java.lang.String name)
-
setType
public void setType(java.lang.String type)
-
setAnnotation
public void setAnnotation(java.lang.String annotation)
-
useNodeValue
protected boolean useNodeValue()
Description copied from class:AbstractConfigurationElement
Controls whether this element will use the node value as a property. For example, nodes defined as:
can expose a property which will return the node's value (This is the node vale). When this is the case, though, the element can't have any sub elements. They're mutually exclusive.<a att="1">This is the node value</a>
- Overrides:
useNodeValue
in classAbstractConfigurationElement
- Returns:
false
by default. Override this method if you want to associate the node value with some property.
-
setNodeValue
protected void setNodeValue(java.lang.String value)
Description copied from class:AbstractConfigurationElement
Returns the node value for this element. The node value represents the inner context of the xml tag. If multipleElementSources
are defined for this element, it returns the value of the one with greater priority.- Overrides:
setNodeValue
in classAbstractConfigurationElement
-
setPropertyValue
public void setPropertyValue(java.lang.String propertyValue)
-
getBlockListConfig
public BlockListConfig getBlockListConfig()
-
getBlockConfig
public BlockConfig getBlockConfig()
-
addBlockConfig
public void addBlockConfig(BlockConfig blockConfig)
-
addBlockListConfig
public void addBlockListConfig(BlockListConfig blockListConfig)
-
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 thegetKey
andsetKey
methods.- Specified by:
getKeyAttribute
in classAbstractConfigurationElement
-
initElementsFromXML
protected void initElementsFromXML(org.w3c.dom.Node root, java.lang.String sourceKey, CustomizationInfo c) throws ConfigException
Description copied from class:AbstractConfigurationElement
Initializes the list of child-elements from givenNode
- Overrides:
initElementsFromXML
in classAbstractConfigurationElement
- Throws:
ConfigException
- See Also:
AbstractConfigurationElement.initFromXML(Node root, String sourceKey, CustomizationInfo c)
-
-