Package com.microstrategy.utils.config
Interface ConfigurationElement
-
- All Superinterfaces:
java.lang.Cloneable
- All Known Subinterfaces:
ActualParameter
,ActualParameters
,BeanDefn
,BeanDefns
,ConfigurationElementList
,Layout
,LayoutParserDefn
,LayoutParserDefns
,Layouts
,LayoutSourceDefn
,LayoutSourceDefns
,MapperDefn
,MapperDefns
,Style
,StyleCatalog
,StyleMap
,StyleMapClause
,StyleMapCondition
,StyleMapDefault
,StyleMaps
,Styles
,TransformDefn
,TransformDefns
- All Known Implementing Classes:
AbstractConfigurationElement
,AbstractConfigurationElementList
,AbstractElementList
,AbstractStyleCatalogElement
,AbstractStyleCatalogList
,ActualParameterImpl
,ActualParameterInfo
,ActualParametersImpl
,AddonInfo
,AddonInfoList
,AdminServer
,AdminServersList
,AggregatingTaskFactoryConfig
,AllowContentTypes
,AllowDomains
,AltConnectionInfo
,AltDBParamInfoList
,AltDBParamSectionInfoList
,ApplicationParameters
,AppschemaDisabledSourceInfo
,AppschemaDisabledSources
,AreaLayerInfo
,AreaLayersInfoList
,ArgumentInfo
,Assignments
,BaseMapInfo
,BaseMapsInfoList
,BeanDefnImpl
,BeanDefnsImpl
,BeanFactory.BeanFactoryInfo
,BeanFactory.BeanMappingInfo
,BeanFactory.BeanMappingInfoList
,BeanFactory.BeanPackageInfo
,BeanFactory.BeanPackageInfoList
,BeanInfo
,BeanTaskConfig
,BlockConfig
,BlockLibraryConfig
,BlockListConfig
,BrowserSettingDefinition
,BrowserSettingDefinitionList
,ClientSideLayout
,ConnectionInfo
,ContentType
,ContextInfo
,ContextMenuInfo
,ContextMenuList
,ControllerInfo
,ControllerInfoList
,CustomThreshold
,CustomThresholdBand
,CustomThresholdBandList
,CustomThresholdList
,CustomThresholdsInfo
,DBIDInfo
,DBIDsInfoList
,DBInfo
,DBParamInfoList
,DBParamSectionInfoList
,DBParamValInfo
,DBPreferenceInfo
,DBPreferenceItem
,DBPreferenceItemList
,DBPreferencesInfoList
,DBPropertiesInfo
,DBsInfoList
,DBTypeInfo
,DBTypesInfoList
,DBVersionInfo
,DBVersionsInfoList
,DBVLDBProperty
,DBVLDBPropertyList
,Definition
,DenyDomains
,Domain
,DropZone
,DropZonesResolution
,DynamicMenus
,ErrorInfo
,ErrorInfo.ErrorMessage
,ErrorInfo.ErrorTitle
,ErrorInfoList
,ESRICloudAppInfo
,ESRICloudAppKeyInfo
,ESRICloudAppsInfo
,ESRICloudAppsInfoList
,ESRIConfigurationInfo
,ESRIGeoShapeInfo
,ESRIGeoShapesInfoList
,ESRIJSAPIUrlInfo
,ESRIOnPremiseAttributeInfo
,ESRIOnPremiseMapLayerUrlInfo
,ESRIOnPremiseQueryFieldInfo
,ESRIProxyURL
,ESRIProxyURLList
,ESRIWebMapInfo
,ESRIWebMapsInfoList
,EventArgumentInfo
,EventArgumentInfoList
,EventFlagList
,EventFlagListSet
,EventHandlerInfo
,EventHandlerInfo
,EventHandlerList
,EventHandlersCatalog
,EventInfo
,EventInfo
,EventInfoList
,EventList
,EventListSet
,EventMap
,EventMap.EventMapArgument
,EventMapList
,ExportFormat
,ExportFormatList
,ExportPlaintextDelimiter
,ExportPlaintextDelimiterList
,FlagInfo
,FolderLink
,FolderMapping
,FolderMappingList
,GeoRoleInfo
,GeoRolesInfoList
,GeoShapeInfo
,GeoShapesInfoList
,GoogleChannel
,GoogleConfigurationInfo
,GoogleMapKeyInfo
,GraphFormatInfoHelper.Attribute
,GraphFormatInfoHelper.Exception
,GraphFormatInfoHelper.Exceptions
,GraphFormatInfoHelper.GraphAttribute
,GraphFormatInfoHelper.GraphAttributes
,GraphFormatInfoHelper.GraphFormatInfo
,GraphFormatInfoHelper.GraphMajorType
,GraphFormatInfoHelper.GraphMajorTypes
,GraphFormatInfoHelper.GraphMinorType
,GraphFormatInfoHelper.GraphMinorTypes
,GraphFormatInfoHelper.GraphObject
,GraphFormatInfoHelper.GraphObjects
,GraphFormatInfoHelper.IncludeType
,GraphFormatInfoHelper.IncludeTypes
,IncludeBlock
,IncludeDir
,JavaScriptInfo
,JavaScriptInfoList
,LayoutImpl
,LayoutParserDefnImpl
,LayoutParserDefnsImpl
,LayoutsImpl
,LayoutSourceDefnImpl
,LayoutSourceDefnsImpl
,Macro
,Macros
,MapBoxConfigurationInfo
,MapBoxTokenInfo
,MapDecorations
,MapNameConversionElement
,MapNameConversions
,MapperDefnImpl
,MapperDefnsImpl
,MapStyle
,MapStyleJson
,MapStyleList
,MessageInfoImpl
,MessagesManager
,MicrostrategyAttributeInfo
,MicrostrategyProjectInfoList
,MicrostrategyProjectsInfoList
,MSTRGeoShapeInfo
,MSTRGeoShapesInfoList
,MSTRShapeConfigurationInfo
,MultiMapConfigurationInfo
,ObjBrowserFolderLinks
,PageInfo
,PageInfoList
,PageManager
,PaperSizes
,PaperSizesList
,ParameterInfo
,ParameterInfo.Description
,ParameterInfoList
,ProjectInfo
,Properties
,Property
,Property
,PropertySet
,PropertySets
,PropertyValue
,ResourceFeedConfig
,RibbonInfo
,RibbonList
,RibbonListSet
,SectionInfo
,SectionInfoList
,ShapeConfigurationInfo
,ShapeFileMap
,ShapeFileMaps
,ShapeKeyInfo
,ShapeKeysInfoList
,Shortcut
,ShortcutArgument
,ShortcutEvent
,ShortcutList
,ShortcutListSet
,StaticSession
,StaticSessionList
,StyleCatalogImpl
,StyleImpl
,StyleInfo
,StyleMapConditionImpl
,StyleMapDefaultImpl
,StyleMapImpl
,StyleMapsImpl
,StylesImpl
,SysFolderBlackListHelper.SystemFolderNode
,SystemPickerList
,TaskFactoryInfo
,TaskFactoryList
,TaskFactoryParam
,TaskFactoryParamList
,TaskInfo
,TaskMetadataImpl
,TaskParameterMetadataImpl
,TasksList
,TemplateInfo
,TemplateInfoList
,ToolbarInfoList
,TransformDefnImpl
,TransformDefnsImpl
,Transition
,Transitions
,UpdateFilterInfo
,Visualization
,VisualizationGallery
,VisualizationGroup
,VisualizationGroups
,VisualizationList
,Visualizations
,VisualizationTemplate
,VisualizationTemplateId
,VisualizationTemplates
,WebAttribute
,WebAttributeList
,WebBeanInfo
,WebBeanInfoList
,WebBeanProperty
,WebBeanPropertyList
,WebBeanStyle
,WebBeanStyleList
,WebGuiComponent
,WebGuiComponentList
,WebLoginProviderInfo
,WebLoginProviderList
,WebWrapperAttributeList
,WhiteListCommandHelper
,WhiteListCommandHelper.LibraryWhiteListCommandInfo
,WhiteListCommandHelper.MobileWhiteListCommandInfo
,WhiteListCommandHelper.WebWhiteListCommandInfo
,WhiteListCommandHelper.WhiteListCommand
,WhiteListCommandHelper.WhiteListCommandInfo
,Widget
,WidgetProp
,WidgetProps
,Widgets
public interface ConfigurationElement extends java.lang.Cloneable
This is the base interface used by those classes that represent a configuration element, that is, a class that can be configured using an external file. Each configuration element is basically made off from:- a node name
- a list of attributes (string values)
- a list of child configuration elements.
getKey()
method, which is used to uniquely identified this element among its siblings. As an example, take the following xml-definition in a configuration file:
"a" will have 2 attributes (att0 and att1) and 4 child-elements (b, d, d, d).<a att0="0" att1="0"> <b att="0" /> <d name="d0" att="0" /> <d name="d1" att="1"/> <d name="d2" att="2" /> </a>
"b" can be accessed withgetElement("b")
. The list of "d" elements can be accessed withgetList("d")
. Notice thatgetElement("d")
will return a single ConfigurationElement whose elements are "d0" through "d2".- Since:
- MicroStrategy Web 9.0.0
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description ConfigurationValue
getAttribute(java.lang.String name)
Returns the value associated with the given attribute.HashList
getAttributes()
Returns the list of all attributes available to this ConfigurationElement.ConfigurationElement
getElement(java.lang.Object nodeName)
Returns theConfigurationElement
instance associated with the given nodeName.HashList
getElements()
Returns the list of all child-elements available to this ConfigurationElement.java.lang.Object
getKey()
This method is used to uniquely identify this ConfigurationElement within a list.java.lang.String
getNodeName()
Returns the node-name for this element.java.lang.String
getStrAttribute(java.lang.String name)
void
initFromXML(org.w3c.dom.Node root)
Initializes the object with information from an XML Node.void
reload()
Triggers the re-initialization of the element and its children if the configuration files have changed.org.w3c.dom.Element
toXML(org.w3c.dom.Document doc)
Utility method to get the object's XML representation.
-
-
-
Method Detail
-
getAttributes
HashList getAttributes()
Returns the list of all attributes available to this ConfigurationElement.
-
getElements
HashList getElements()
Returns the list of all child-elements available to this ConfigurationElement.
-
getAttribute
ConfigurationValue getAttribute(java.lang.String name)
Returns the value associated with the given attribute. If the attribute was not present in the xml configuration the method returns null. If multipleElementSources
are defined for this element, it returns the value of the one with greater priority.
-
getElement
ConfigurationElement getElement(java.lang.Object nodeName)
Returns theConfigurationElement
instance associated with the given nodeName. If theConfigurationElement
was not present in the xml configuration, this method shall return an empty instance of theConfigurationElement
. If a list is associated with the given nodeName, this method returns an instance a singleConfigurationElement
whose children are theConfigurationElement
instances for that nodeName. If noConfigurationElement
is associated with the given nodeName, the method returns null.
-
getNodeName
java.lang.String getNodeName()
Returns the node-name for this element.
-
getKey
java.lang.Object getKey()
This method is used to uniquely identify this ConfigurationElement within a list. Typically this is mapped to the value of a single attribute, but this is not necessary as each ConfigurationElement can define its own schema.
If it's not possible to uniquely identify this object, this method should return null.- Returns:
- The value representing the key of this object, null if there is no key available.
-
initFromXML
void initFromXML(org.w3c.dom.Node root)
Initializes the object with information from an XML Node.- Parameters:
root
- Node intance representing the configuration element properties
-
toXML
org.w3c.dom.Element toXML(org.w3c.dom.Document doc)
Utility method to get the object's XML representation.- Parameters:
doc
- Document object where the new element will be created from.- Returns:
- an XML
Element
instance of the object being represented
-
reload
void reload() throws ConfigException
Triggers the re-initialization of the element and its children if the configuration files have changed.- Throws:
ConfigException
-
getStrAttribute
java.lang.String getStrAttribute(java.lang.String name)
-
-