AbstractConfigurationElement

Defines the "use-default" attribute.

Default constructor. Calls initDefaultAttributes()

Applies the corresponding customizations.

Loops through all the CustomizationInfo in the Customizations class and apply the corresponding customizations.

This method when called will delete all the child elements that are marked as deleted.

Returns the deltas between the original() and this objects. The returned value therefore includes all changes to this object after it was loaded; this includes both programatic changes and plugins changes.

Returns a partial instance of this object that contains the attributes and elements required to make this object equals to the other paramter. It is used to identify the differences between the two instances of this class.

Being a partial instance, the resulting delta includes strictly those attributes and elements required to make it equal to the other object; typically default attributes and elements are not included so its possible that getter methods for properties and/or chidlren will return null.

x != y

 d = x.deltas(y)
 x + d = y
 

 if (!x.equals(y)) {
   AbstractConfigurationElement d = x.deltas(y);
   x.populates(d).equals(y); //returns true
 }
 

Returns the value associated with the given attribute. If the attribute was not present in the xml configuration the method returns null.

Returns the list of all attributes available to this ConfigurationElement.

Returns the value of the config-src attribute. This attribute indicates a file path where the definition of this attribute will be loaded from or saved into.

Returns the ConfigurationElement instance associated with the given nodeName. If the ConfigurationElement was not present in the xml configuration, this method might return an empty instance of the corresponding ConfigurationElement or null depending on the canBeNull parameter passed to the registerElement(String, Class) method. If a list is associated with the given nodeName, this method returns a list containing all the ConfigurationElement instances for that nodeName. If no ConfigurationElement is associated with the given nodeName, the method returns null.

Returns the list of all child-elements available to this ConfigurationElement.

Returns the file loader instance used by this ConfigurationElement to load files from the file system. If setFileLoader(FileLoader) has not been explicitly called, this method uses the parent's FileLoader, and if it is a root object, it uses the FileLoader singleton, that is FileLoader.getInstance().

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.

Returns the line number (if known) of the element in the XML file.

Returns an object that can be used as key for a list of child-elements that doesn't have a key by itself.

Returns the node-name for this element.

Returns the node value for this element. The node value represents the inner content of the xml tag. If multiple ElementSources are defined for this element, it returns the value of the one with greater priority.

Gets the parent for this configuration element. Returns null if it's a root or if it's still not associated to any element.

Returns the expected position of this element. If the position should be automatically infered from the position found in the XML, it returns -1. This value is stored in the "position" attribute of the node. Notice that the actual position of this element might differ from this value, as the position attribute is not guaranteed to be unique or correct.

Returns the path to the file where this configuration element was originally loaded from. It only returns a non-null value when this element was loaded using the load(String) method, or if it was loaded from a node that had the "config-src" attribute specified.

Helper method, returns the value of the given attribute as a string.

Returns the use-default value.

Initializes this configuration element by loading the contents a resource that exists in the class path.

Initialize the attributes and child elements from the values in the given Node

Returns true is this element has been mark as deleted.

Returns true is this element or one of its children has been modified programatically after being loaded.

Loads the file with the given name and initializes this ConfigurationElement with its content.

Returns a new instance of this object, populated only with the out of the box values of Microstrategy Web, that is, only default values or those that came from the load method. Values from customizations or programatic changes are not included.

This method takes another configuration element and populates this element with the other's attributes and child-elements. Existing values are merged in this process. After this method is called, attributes and elements from the other will be available in this element.

Loops through all the ElementSource of this ConfigurationElement and reloads the content of those whose underlying configuration file has changed.

Saves this ConfigurationElement back into the files where it was loaded from. All in-memory changes are automatically applied into the last ElementSource used to load this element.

Saves deltas for this ConfigurationElement into the given CustomizationInfo.

Saves all in-memory changes to the given file. If this ConfigurationElement was loaded from that file, the resulting file includes the original contents plus the changes.

Saves this element configuration into the given filePath. Notice that this method has been deprecated: To save the configuration file into a different location it's better to create a FileLoader with the new folder path and assign it to the root element:

PageManager pm = new PageManager(); pm.load(".\\WEB-INF\\xml\\pageConfig.xml"); FileLoader fl = new FileLoader(System.getProperty("user.dir") + OUTPUT_FOLDER); //Save it in a different folder: pm.setFileLoader(fl); pm.save();

Saves the current element structure, in XML format, into the given file.

Sets the config-src attribute. If setting it to a non-null value, the definiton of this configuration element will be saved into this location.

set if this element is a customized element or not. If user adds a new element it is considered a customized element and user needs to set this element as custom.

Sets the FileLoader instance to be used to load files. This method is typically used to set a different root folder for relative paths. Normally, all relative paths (for example "/WEB-INF/web.xml") are relative to the application's root folder, to change this root folder users can create a new FileLoader instance and set it to this ConfigurationElement, then relative paths are resolved relative to the new FileLoader base path, for example:

FileLoader fl = new FileLoader("C:\\Temp"); PagaManager pm = new PageManager(); pm.load("/WEB-INF/xml/pageConfig.xml", true);

Sets the line number of the element in the XML file.

Sets the expected position of this element. The value is stored in the "position" attribute of the node. If when calling this method, this instance is a member of an ImplicitList, the element will automatically reposition itself in this list. Setting -1 as position indicates to automatically position this element based on its position in the XML.

The definition of a ConfigurationElement can come come from different sources, for example, the definition can come from an external file (by specifying a getConfigSrc() value), or it can be modified through a Customization. When the useDefault is set to false, values that come from previous sources are ignored and only the definition from the current source is used; this includes all attributes and child elements of this element. This is especially useful in customizations to replace the out of the box values of a node with a new definition.

Defines whether the XML content should validated using a DTD.

Generates the String representation of this ConfigurationElement.

Generates the DOM representation of this ConfigurationElement. This method returns the list of attributes and elements merged from all ElementSource. Note that the resulting Element will not be associated with the Document parameter. It is important to ensure that all DOM trees have a Document root as some serializers do not behave correctly otherwise. Use toXML() if the resulting DOM is not going to be appended in another DOM structure.

Generates the DOM representation of this ConfigurationElement. This method returns the list of attributes and elements merged from all ElementSource.

Returns whether the XML content should be validated using a DTD. If true when the XML is parsed the file will be validated using the corresponding DTD (as defined in the XML itself).

Adds a reference to a file from a config-source. This file will then be automatically reloaded if changed and will be used when the save() method is called.

Returns true if the list of active attributes of the given AbstractConfigurationElement is equal to this list of active attributes of this AbstractConfigurationElement.

Returns true if the list of all child elements of the given AbstractConfigurationElement is equal to this list of all child-elements of this AbstractConfigurationElement.

Returns true if the node value of both configuration elements is the same.

Appends the list of attributes of this ConfigurationElement into the given node. The list is filter to include only attributes defined in the given ElementSource. If sourceKey is null, it appends the list of attributes merged from all ElementSources.

Appends the list of child-elements of this ConfigurationElement into the given node. The list is filter to include only elements defined in the given ElementSource. If sourceKey is null, it appends the list of elements merged from all ElementSources.

Appends the node value associated with the given source key into the given node. If sourceKey is null, it appends the current node value.

Helper method, returns the value of the given attribute as boolean (true/false). If the attribute has no value it returns false; otherwise it returns valueOf(boolean).

Returns the key that uniquely identifies the child element associated with the given Node.

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.

Helper method, returns the value of the given attribute as integer. If the attribute has no value, it returns Integer.MIN_VALUE. If the attribute has a non-numeric value, it throws an IllegalArgumentException.

Helper method, returns the value of the given attribute as integer. If the attribute has no value, it returns the defaultValue parameter. If the attribute has a non-numeric value, it throws an IllegalArgumentException.

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.

Returns an ImplicitList with all the elements associated with the given nodeName. If no child was present in the xml configuration with this name, it will return an empty list. If the nodeName has not been registered for a list, it throws an IllegalArgumentException.

Returns the node value for this element in the given sourceKey. The node value represents the inner content of the xml tag.
If sourceKey is null, it returns the current value.

Returns the current child instance; if null but the child is registered, it creates a new instance for it.

Returns the current prototype of this instance.

Returns the Class associated with the given nodeName.

Gets the ElementSource for the given key. If there is no ConfigurationSource for the given key, a new source is automatically added.

Returns an instance of ParserParameters used by the XML parser. By default if using validation creates a new ParserParameters instance with a SimpleErrorHandler and FileLoaderEntityResolver; otherwise it returns null;

Returns an instance of SerializerParameters used by the XML serializer in the toXML() By default it returns null. Override if the configuration element requires to pass different parameters than those used by default.

Returns true is there is a child registered for the given nodeName.

Returns the hashcode for attributes.

Returns the hashcode for attributes.

Returns the hashcode for attributes.

Initializes the list of attributes from given Node

This method can be overridden to set default values for attributes. Simply extend this method and call setAttribute(String, Object)

Initializes a single child-element from the given Node

Initializes the list of child-elements from given Node

Initializes this configuration element by loading the contents of the given filePath using the corresponding CustomizationInfo.

Initialize the attributes and child elements from the values in the given Node

Initializes the list of child-elements from given Node

Inits the prototype object of this element. This element will inherit all the attribute and child elements from the prototype, but then any values defined through the config-src file or inline take precedence over the prototype. The name attribute represents the name of the prototype as specified in the XML. Typically this is the name of a sibling node in the xml. If name is empty, a different sibling might be used as prototype (like in the case of the PageInfo, which the page marked as isDefault is used as the default prototype). If this object already has a prototype, or if the prototype is not found in the siblings collections this methods throws an Exception.

Returns true if the element already contains an ElementSource for the given key.

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

Removes deltas and applies them to the given source.

Creates a new instance of a child element for the given class.

Create a new ElementSource and adds to the list of sources of this element. If there is already an ElementSource for the given key, this method will return the same instance, but this should be avoided to prevent infinite recursive loops with the config-src attribute.

Appends the list of attributes of this ConfigurationElement into the given StringBuffer. It includes the list attributes merged from all ElementSources.

Appends the list of child-elements of this ConfigurationElement into the given StringBuffer. It appends the list of elements merged from all ElementSources.

Appends the node value into the given StringBuffer. It appends the node value of elements merged from all ElementSources.

Registers a child class for the child with the given nodeName. Used to keep track of those children than can have null values.

Register a child of this ConfigurationElement. When a node with the given name is found in the configuration file, an instance of c is created and initialized with the corresponding configuration. It's assumed that only one child with this name is available in the configuration file; if more than one is found, the corresponding nodes are merged into a single ConfigurationElement.

The canBeNull parameter controls whether the child instance is created by default or not. When false, the getElement(Object) will always return a non-null instance even if the child is not in the XML; if true the child instance is only created if the object is found in the XML, in this case null checks are necessary in your code after calling getElement to make sure the return object is not null.

Register a child of this ConfigurationElement. When a child is registered with this method it is guaranteed that a non-null instance of this child is returned by the getElement(Object) method regardless of the child being present in the XML or not.

Register a list of this ConfigurationElement. When a node with the given name is found in the configuration file, an instance of c is created and initialized with the corresponding configuration. If more than one subnodes are found with this name, one instance for each is created and all of them are added as child of this ConfigurationElement. The list can then be accessed through the getList(String) method.

Only elements registered with this and with the registerElement(String, Class) methods are valid child nodes in the configuration file.

This method should only be called in the constructor, otherwise the clone method will fail. It can only be called if the useNodeValue() method returns false as they are mutually exclusive: by design an element can only use children if its not using the node value.

Currently it is required that all registered child elements extend AbstractConfigurationElement. If the given class c doesn't, this method will throw an IllegalArgumentException.

Loops through all the ElementSource of this ConfigurationElement and reloads the content of those whose underlying configuration file has changed.

Completely remove the value for the given attribute.

This method is called when the use-default attribute is set false, so all previous values of attributes and children must be cleared.

Saves an XML node into a file in the given location.

Saves only the contents associated with the given source.

Sets the value for the given attribute.

Helper method, sets the value of the given attribute from a boolean.

Allows users to add or replace an element. If an element with the given key already exists it gets replaced, otherwise it's simply added.

Helper method, sets the value of the given attribute from an integer.

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

Sets the name of the node associated with this configuration element.

Returns the node value for this element. The node value represents the inner context of the xml tag. If multiple ElementSources are defined for this element, it returns the value of the one with greater priority.

Sets the prototype object for this instance. The attributes and elements of the prototype are copied into this instance.

Helper method, sets the value of the given attribute as a string.

Generates the DOM representation of this ConfigurationElement for the list of attributes and elements defined in the given ElementSource.

Generates the DOM representation of this ConfigurationElement for the list of attributes and elements defined in the given ElementSource. Note that the resulting Element will not be associated with the Document parameter. It is important to ensure that all DOM trees have a Document root as some serializers do not behave correctly otherwise.

Controls whether this element will use the node value as a property. For example, nodes defined as:

  <a att="1">This is the node value</a>