IlvSettings (Perforce JViews 10.0 API)

java.lang.Object
- ilog.views.appframe.settings.IlvSettings

All Implemented Interfaces:

Document, Node

Direct Known Subclasses:

IlvBeanSettings, IlvSettingsManager, IlvXMLSettings
```
public class IlvSettings
extends Object
implements Document
```
Settings are hierarchical data for configuring all kinds of objects.
They also transparently track the modifications made by the objects to their initial settings values. Modifications are saved in the user settings and restored in the next session of the application for the same user profile.
Settings are used for initializing Application Framework components, such as an IlvMenuBar. They also provide an API for initializing user objects.
Settings model
Data accessed by the settings is specified in an IlvSettingsModel that is instantiated with the createModel(short) method. Settings classes are provided for initializing the settings from different types of settings model:
- The IlvXMLSettings class initializes the settings from XML streams.
- The IlvBeanSettings class initializes the settings from bean properties.
Settings query
Objects accessed by settings are selected using query methods:
See IlvSettingsQuery for more information on how to construct a query.
Result elements
Objects of the settings model selected by those queries are not directly accessible to the user. Instead, IlvSettingsNode instances are returned. Settings nodes can be either IlvSettingsAttribute or IlvSettingsElement instances.
They facilitate the manipulation of the objects of the model in many ways.
First, they cascade those objects transparently. If the settings are a settings manager, objects of the model can be selected in several settings with the same query. The settings element cascades the attributes of those objects and gives access to them as only one node.
Secondly, they return typed values to the user, such as IlvSettingsElement.getInt(java.lang.String) or IlvSettingsElement.getFont(java.lang.String), which ease the initialization of user objects initialized from the settings.
Customized settings
You can initialize your settings from other sources by defining your own IlvSettingsModel or IlvMutableSettingsModel implementation. This settings model can be set to an IlvSettings. Its data is accessible with all the query methods of the IlvSettings class returning the same resulting settings nodes,

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`IlvSettings.AttributeID` Defines ID values that contain the value and the name of an attribute.
`static class`	`IlvSettings.IDAttributeMapper` Maps the ID value of a settings element with the value of a specified attribute.
`static interface`	`IlvSettings.IDResolver` Provides ID values for objects of the settings models.

Field Summary

Fields
Modifier and Type	Field and Description
`static short`	`APPLY_DIFF_MODE` Cascading constant used when settings are merged with other settings within a settings manager.
`static String`	`EVERY_NODE_KEY` Key to be used in a query to specify that all the nodes that the axis of the query applies to must be selected.
`static short`	`READABLE` Access right constant used to specify that the settings elements can be read.
`static short`	`SET_MODE` Cascading constant used when settings are merged with other settings within a settings manager.
`static short`	`UNREADABLE` Access right constant used to specify that the settings elements can neither be read nor modified.
`static boolean`	`VERBOSE` Static variable that specifies whether verbose strings depending on the Settings API should be printed on the `System.out` output.
`static short`	`WRITABLE` Access right constant used to specify that the settings elements can be modified.

Constructor Summary

Constructors
Constructor and Description
`IlvSettings()` Constructs a new empty `IlvSettings`, without associated model and without name.
`IlvSettings(String name)` Constructs a new `IlvSettings` with the specified `name`.
`IlvSettings(String name, IlvSettingsModel model)` Constructs settings with the specified name and model.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addIDResolver(IlvSettings.IDResolver resolver)` Adds the specified ID resolver for providing ID attributes for new settings types.
`void`	`addSettingsElement(IlvSettingsElement parentElement, IlvSettingsElement element, int index)` Adds the specified element to the specified parent.
`Node`	`adoptNode(Node source)`
`Node`	`appendChild(Node newChild)` Adds the node `newChild` to the end of the list of children of this node.
`boolean`	`areSettingsInitialized()` Determines whether those settings are initialized.
`boolean`	`canWrite()` Determines whether those settings can be modified by checking if the value returned by the method `getAccessRights()` contains the tag value `WRITABLE`.
`Node`	`cloneNode(boolean deep)` Returns a duplicate of this node, i.e., serves as a generic copy constructor for nodes.
`void`	`commit()` Commits the changes made on the model associated with those settings.
`short`	`compareDocumentPosition(Node other)`
`Attr`	`createAttribute(String name)` Creates an `Attr` of the given name.
`Attr`	`createAttributeNS(String namespaceURI, String qualifiedName)` Creates an attribute of the given qualified name and namespace URI.
`CDATASection`	`createCDATASection(String data)` Creates a `CDATASection` node whose value is the specified string.
`Comment`	`createComment(String data)` Creates a `Comment` node given the specified string.
`DocumentFragment`	`createDocumentFragment()` Creates an empty `DocumentFragment` object.
`Element`	`createElement(String tagName)` Creates an element of the type specified.
`Element`	`createElementNS(String namespaceURI, String qualifiedName)` Creates an element of the given qualified name and namespace URI.
`EntityReference`	`createEntityReference(String name)` Creates an `EntityReference` object.
`protected IlvSettingsModel`	`createModel(short accessRights)` Creates the model of those settings.
`ProcessingInstruction`	`createProcessingInstruction(String target, String data)` Creates a `ProcessingInstruction` node given the specified name and data strings.
`IlvSettingsElement`	`createSettingsElement(String type)` Creates a new element with the specified type.
`Text`	`createTextNode(String data)` Creates a `Text` node given the specified string.
`Object`	`ensureCorrespondingElement(IlvSettingsElement element)` Ensures that the specified settings `element` has a cascaded element in these settings.
`IlvSettingsElement`	`ensureSettingsElement(IlvSettingsQuery query)` Ensures that a settings element of those settings is selectable from the specified `query`.
`IlvSettingsElement`	`ensureSettingsElement(String type)` Ensures that a root settings element with the specified `type` exists in those settings.
`short`	`getAccessRights()` Returns the access rights for reading and modifying the model associated with those settings.
`IlvApplication`	`getApplication()` Returns the application of those settings.
`NamedNodeMap`	`getAttributes()` Returns `null` as a document has no attributes.
`String`	`getBaseURI()`
`short`	`getCascadingMode()` Specifies how the content of those settings should be merged with other settings if those settings are inserted into an `IlvSettingsManager` manager.
`NodeList`	`getChildNodes()` A `NodeList` that contains all children of this node.
`DocumentType`	`getDoctype()` The Document Type Declaration (see `DocumentType`) associated with this document.
`Element`	`getDocumentElement()` This is a convenience attribute that allows direct access to the child node that is the root element of the document.
`String`	`getDocumentURI()`
`DOMConfiguration`	`getDomConfig()`
`Element`	`getElementById(String elementId)` Returns the `Element` whose `ID` is given by `elementId`.
`NodeList`	`getElementsByTagName(String tagname)` Returns a `NodeList` of all the `Elements` with a given tag name in the order in which they are encountered in a preorder traversal of the `Document` tree.
`NodeList`	`getElementsByTagNameNS(String namespaceURI, String localName)` Returns a `NodeList` of all the `Elements` with a given local name and namespace URI in the order in which they are encountered in a preorder traversal of the `Document` tree.
`Object`	`getFeature(String feature, String version)`
`Node`	`getFirstChild()` The first child of this node.
`Object`	`getID(Object element)` Returns the ID value for the specified settings element owned by those settings.
`protected Object`	`getID(Object element, String type, IlvSettingsModel model)` Returns the ID value that uniquely identifies the specified object of the model among other objects with the same type and parent.
`DOMImplementation`	`getImplementation()` The `DOMImplementation` object that handles this document.
`String`	`getInputEncoding()`
`Node`	`getLastChild()` The last child of this node.
`String`	`getLocalName()` Returns the local part of the qualified name of this node.
`IlvSettingsModel`	`getModel()` Returns the model of those settings.
`IlvMutableSettingsModel`	`getMutableModel()` Returns the mutable model associated with this model.
`String`	`getName()` Returns the name of those settings.
`String`	`getNamespaceURI()` Implementation of the method `Node.getNamespaceURI()` method.
`Node`	`getNextSibling()` The node immediately following this node.
`String`	`getNodeName()` The name of this node.
`short`	`getNodeType()` A code representing the type of this node.
`String`	`getNodeValue()` `null` as this node is a document and has not associated value.
`Document`	`getOwnerDocument()` The `Document` object associated with this node.
`Node`	`getParentNode()` The parent of this node.
`String`	`getPrefix()` Implementation of the method `Node.getPrefix()` method.
`Node`	`getPreviousSibling()` The node immediately preceding this node.
`IlvSettingsManager`	`getSettingsManager()` Returns the settings manager that owns those settings.
`boolean`	`getStrictErrorChecking()`
`String`	`getTextContent()`
`Object`	`getUserData(String key)`
`String`	`getXmlEncoding()`
`boolean`	`getXmlStandalone()`
`String`	`getXmlVersion()`
`boolean`	`hasAttributes()` Returns whether this node (if it is an element) has any attributes.
`boolean`	`hasChildNodes()` Returns whether this node has any children.
`Node`	`importNode(Node importedNode, boolean deep)` Imports a node from another document to this document.
`boolean`	`initializeSettings()` Initializes the settings.
`Node`	`insertBefore(Node newChild, Node refChild)` Inserts the node `newChild` before the existing child node `refChild`.
`boolean`	`isDefaultNamespace(String namespaceURI)`
`boolean`	`isEqualNode(Node arg)`
`static boolean`	`IsEveryNodeKey(String key)` Determines whether the specified key selects all the nodes if used in a query.
`boolean`	`isSameNode(Node other)`
`boolean`	`isSupported(String feature, String version)` Tests whether the DOM implementation implements a specific feature and that feature is supported by this node.
`String`	`lookupNamespaceURI(String prefix)`
`String`	`lookupPrefix(String namespaceURI)`
`void`	`normalize()` Puts all `Text` nodes in the full depth of the sub-tree underneath this `Node`, including attribute nodes, into a "normal" form where only structure (e.g., elements, comments, processing instructions, CDATA sections, and entity references) separates `Text` nodes, i.e., there are neither adjacent `Text` nodes nor empty `Text` nodes.
`void`	`normalizeDocument()`
`boolean`	`removeAllSettingsElements(IlvSettingsElement parent, String type)` Removes all the settings elements that are children of the specified `parent` element and have the specified type.
`Node`	`removeChild(Node oldChild)` Removes the child node indicated by `oldChild` from the list of children, and returns it.
`boolean`	`removeIDResolver(IlvSettings.IDResolver resolver)` Removes the specified ID resolver from the list of mappers stored in those settings.
`boolean`	`removeSettingsElement(IlvSettingsElement element)` Removes the model element of the settings referenced by the specified settings element.
`Node`	`renameNode(Node n, String namespaceURI, String qualifiedName)`
`Node`	`replaceChild(Node newChild, Node oldChild)` Replaces the child node `oldChild` with `newChild` in the list of children, and returns the `oldChild` node.
`IlvSettingsElement[]`	`select(IlvSettingsQuery query)` Returns the settings elements selected by the specified query.
`IlvSettingsElement[]`	`select(IlvSettingsQuery query, IlvSettingsElement[] contextElements)` Returns the settings elements selected by the specified query from the specified settings element.
`IlvSettingsElement[]`	`select(String type, IlvSettingsElement[] contextElements)` Returns the settings elements with the specified settings type and children of the specified `contextElements`.
`IlvSettingsElement`	`selectElement(IlvSettingsQuery query)` Returns the first settings element selected by the specified query.
`IlvSettingsElement`	`selectElement(String type)` Returns the first root settings element with the specified type.
`IlvSettingsElement`	`selectElement(String type, String attributeName, Object attributeValue)` Returns the first root settings element selected by the specified query parameters.
`IlvSettingsNode[]`	`selectNodes(IlvSettingsQuery query)` Returns the settings nodes selected by the specified query.
`void`	`setAccessRights(short accessRights)` Sets the rights for accessing the model associated with those settings.
`void`	`setApplication(IlvApplication application)` Sets the application that owns those settings.
`void`	`setCascadingMode(short mode)` Sets the cascading mode of those settings with other settings.
`void`	`setDocumentURI(String documentURI)`
`protected boolean`	`setID(Object element, Object id, String type, IlvMutableSettingsModel model)` Sets the specified ID value to the specified object of the model.
`void`	`setModel(IlvSettingsModel model)` Sets the model of those settings.
`void`	`setName(String name)` Sets the name of those settings.
`void`	`setNodeValue(String nodeValue)` Sets a value to this node.
`void`	`setPrefix(String prefix)` This method has no effects as documents do not support prefixes.
`void`	`setSettingsManager(IlvSettingsManager manager)` Sets the settings manager that owns those settings.
`void`	`setStrictErrorChecking(boolean strictErrorChecking)`
`void`	`setTextContent(String textContent)`
`Object`	`setUserData(String key, Object data, UserDataHandler handler)`
`void`	`setXmlStandalone(boolean xmlStandalone)`
`void`	`setXmlVersion(String xmlVersion)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - WRITABLE
```
public static final short WRITABLE
```
    Access right constant used to specify that the settings elements can be modified.
    
    See Also:
    
    Constant Field Values
  - READABLE
```
public static final short READABLE
```
    Access right constant used to specify that the settings elements can be read.
    
    See Also:
    
    Constant Field Values
  - UNREADABLE
```
public static final short UNREADABLE
```
    Access right constant used to specify that the settings elements can neither be read nor modified.
    
    See Also:
    
    Constant Field Values
  - SET_MODE
```
public static final short SET_MODE
```
    Cascading constant used when settings are merged with other settings within a settings manager.
    It specifies that the nodes that are selected in those settings erase the nodes selected with the same query in settings with lower priority in the settings manager.
    
    See Also:
    
    getCascadingMode(), setCascadingMode(short), Constant Field Values
  - APPLY_DIFF_MODE
```
public static final short APPLY_DIFF_MODE
```
    Cascading constant used when settings are merged with other settings within a settings manager.
    It specifies that the settings it applies to represent modifications to make to settings nodes of settings of lower priority. While processing a query, settings with this mode can remove or change the attributes of nodes previously selected by settings of lower priority for the same query.
    
    See Also:
    
    getCascadingMode(), setCascadingMode(short), Constant Field Values
  - EVERY_NODE_KEY
```
public static String EVERY_NODE_KEY
```
    Key to be used in a query to specify that all the nodes that the axis of the query applies to must be selected.
    
    See Also:
    
    IsEveryNodeKey(java.lang.String)
  - VERBOSE
```
public static boolean VERBOSE
```
    Static variable that specifies whether verbose strings depending on the Settings API should be printed on the System.out output.
    If true, verbose messages will be printed; if false, there will be no output specific to the Settings API printed. By default, the value of this variable is false.
- Constructor Detail
  - IlvSettings
```
public IlvSettings()
```
    Constructs a new empty IlvSettings, without associated model and without name.
    
    See Also:
    
    setName(java.lang.String), setModel(ilog.views.appframe.settings.IlvSettingsModel)
  - IlvSettings
```
public IlvSettings(String name)
```
    Constructs a new IlvSettings with the specified name.
    
    Parameters:
    
    name - The name of the settings
    
    See Also:
    
    getName(), setModel(ilog.views.appframe.settings.IlvSettingsModel)
  - IlvSettings
```
public IlvSettings(String name,
                   IlvSettingsModel model)
```
    Constructs settings with the specified name and model.
    
    Parameters:
    
    name - The name of the settings.
    
    model - The new model of those settings.
    
    See Also:
    
    getName(), setModel(ilog.views.appframe.settings.IlvSettingsModel)
- Method Detail
  - getBaseURI
```
public String getBaseURI()
```
    Specified by:
    
    getBaseURI in interface Node
  - compareDocumentPosition
```
public short compareDocumentPosition(Node other)
                              throws DOMException
```
    Specified by:
    
    compareDocumentPosition in interface Node
    
    Throws:
    
    DOMException
  - getTextContent
```
public String getTextContent()
                      throws DOMException
```
    Specified by:
    
    getTextContent in interface Node
    
    Throws:
    
    DOMException
  - setTextContent
```
public void setTextContent(String textContent)
                    throws DOMException
```
    Specified by:
    
    setTextContent in interface Node
    
    Throws:
    
    DOMException
  - isSameNode
```
public boolean isSameNode(Node other)
```
    Specified by:
    
    isSameNode in interface Node
  - lookupPrefix
```
public String lookupPrefix(String namespaceURI)
```
    Specified by:
    
    lookupPrefix in interface Node
  - isDefaultNamespace
```
public boolean isDefaultNamespace(String namespaceURI)
```
    Specified by:
    
    isDefaultNamespace in interface Node
  - lookupNamespaceURI
```
public String lookupNamespaceURI(String prefix)
```
    Specified by:
    
    lookupNamespaceURI in interface Node
  - isEqualNode
```
public boolean isEqualNode(Node arg)
```
    Specified by:
    
    isEqualNode in interface Node
  - getFeature
```
public Object getFeature(String feature,
                         String version)
```
    Specified by:
    
    getFeature in interface Node
  - setUserData
```
public Object setUserData(String key,
                          Object data,
                          UserDataHandler handler)
```
    Specified by:
    
    setUserData in interface Node
  - getUserData
```
public Object getUserData(String key)
```
    Specified by:
    
    getUserData in interface Node
  - getInputEncoding
```
public String getInputEncoding()
```
    Specified by:
    
    getInputEncoding in interface Document
  - getXmlEncoding
```
public String getXmlEncoding()
```
    Specified by:
    
    getXmlEncoding in interface Document
  - getXmlStandalone
```
public boolean getXmlStandalone()
```
    Specified by:
    
    getXmlStandalone in interface Document
  - setXmlStandalone
```
public void setXmlStandalone(boolean xmlStandalone)
                      throws DOMException
```
    Specified by:
    
    setXmlStandalone in interface Document
    
    Throws:
    
    DOMException
  - getXmlVersion
```
public String getXmlVersion()
```
    Specified by:
    
    getXmlVersion in interface Document
  - setXmlVersion
```
public void setXmlVersion(String xmlVersion)
                   throws DOMException
```
    Specified by:
    
    setXmlVersion in interface Document
    
    Throws:
    
    DOMException
  - getStrictErrorChecking
```
public boolean getStrictErrorChecking()
```
    Specified by:
    
    getStrictErrorChecking in interface Document
  - setStrictErrorChecking
```
public void setStrictErrorChecking(boolean strictErrorChecking)
```
    Specified by:
    
    setStrictErrorChecking in interface Document
  - getDocumentURI
```
public String getDocumentURI()
```
    Specified by:
    
    getDocumentURI in interface Document
  - setDocumentURI
```
public void setDocumentURI(String documentURI)
```
    Specified by:
    
    setDocumentURI in interface Document
  - adoptNode
```
public Node adoptNode(Node source)
               throws DOMException
```
    Specified by:
    
    adoptNode in interface Document
    
    Throws:
    
    DOMException
  - getDomConfig
```
public DOMConfiguration getDomConfig()
```
    Specified by:
    
    getDomConfig in interface Document
  - normalizeDocument
```
public void normalizeDocument()
```
    Specified by:
    
    normalizeDocument in interface Document
  - renameNode
```
public Node renameNode(Node n,
                       String namespaceURI,
                       String qualifiedName)
                throws DOMException
```
    Specified by:
    
    renameNode in interface Document
    
    Throws:
    
    DOMException
  - getName
```
public String getName()
```
    Returns the name of those settings. This name uniquely identifies those settings among the settings added to an application.
    
    Returns:
    
    The settings name.
    
    See Also:
    
    setName(java.lang.String)
  - setName
```
public void setName(String name)
```
    Sets the name of those settings.
    
    Parameters:
    
    name - The new name of those settings.
    
    See Also:
    
    getName()
  - initializeSettings
```
public boolean initializeSettings()
```
    Initializes the settings. The default implementation is empty.
    
    Returns:
    
    true.
    
    See Also:
    
    areSettingsInitialized()
  - areSettingsInitialized
```
public boolean areSettingsInitialized()
```
    Determines whether those settings are initialized.
    
    Returns:
    
    true if those settings are initialized; false otherwise.
    
    See Also:
    
    initializeSettings()
  - setModel
```
public void setModel(IlvSettingsModel model)
```
    Sets the model of those settings.
    
    Parameters:
    
    model - The new model of those settings.
    
    See Also:
    
    getModel()
  - getModel
```
public IlvSettingsModel getModel()
```
    Returns the model of those settings.
    
    See Also:
    
    setModel(ilog.views.appframe.settings.IlvSettingsModel)
  - getMutableModel
```
public IlvMutableSettingsModel getMutableModel()
```
    Returns the mutable model associated with this model. If no model was specified to those settings or if the model that was set does not implement the interface IlvMutableSettingsModel, null will be returned.
    
    Returns:
    
    The mutable model of those settings.
  - getSettingsManager
```
public IlvSettingsManager getSettingsManager()
```
    Returns the settings manager that owns those settings.
    
    See Also:
    
    setSettingsManager(ilog.views.appframe.settings.IlvSettingsManager)
  - setSettingsManager
```
public void setSettingsManager(IlvSettingsManager manager)
```
    Sets the settings manager that owns those settings.
    
    Parameters:
    
    manager - The new settings manager that owns those settings.
    
    See Also:
    
    getSettingsManager()
  - setApplication
```
public void setApplication(IlvApplication application)
```
    Sets the application that owns those settings.
    
    Parameters:
    
    application - The new application of those settings.
    
    See Also:
    
    getApplication()
  - getApplication
```
public IlvApplication getApplication()
```
    Returns the application of those settings.
    
    See Also:
    
    setApplication(ilog.views.appframe.IlvApplication)
  - commit
```
public void commit()
```
    Commits the changes made on the model associated with those settings. The default implementation is empty.
    
    See Also:
    
    getModel()
  - getAccessRights
```
public short getAccessRights()
```
    Returns the access rights for reading and modifying the model associated with those settings. If the associated model does not implement the IlvMutableSettingsModel interface, the tag value WRITABLE is automatically removed from the returned value.
    In the same way, the tag value UNREADABLE is returned if no model is associated with those settings.
    Returns:
    The access right value. This value is a combination of one or more of the following constants:
    
    UNREADABLE
    
    READABLE
    
    WRITABLE
    See Also:
    
    setAccessRights(short)
  - setAccessRights
```
public void setAccessRights(short accessRights)
```
    Sets the rights for accessing the model associated with those settings.
    
    Parameters:
    
    accessRights - The new rights for accessing the model of those settings.
    
    See Also:
    
    getAccessRights()
  - canWrite
```
public boolean canWrite()
```
    Determines whether those settings can be modified by checking if the value returned by the method getAccessRights() contains the tag value WRITABLE.
  - getID
```
protected Object getID(Object element,
                       String type,
                       IlvSettingsModel model)
```
    Returns the ID value that uniquely identifies the specified object of the model among other objects with the same type and parent.
    The default implementation of this method first tries to get the ID value using the ID mappers added to those settings and to the ascendant settings managers that contain those settings. ID resolvers are added to the settings using the method addIDResolver(ilog.views.appframe.settings.IlvSettings.IDResolver).
    If this search fails, all the attributes of the specified element will be scanned. If an attribute with the name "ID" is found, its value will be returned. Otherwise, if an attribute with the name "name" is found, its value will be returned. Comparison between attribute names and those two names is case insensitive.
    If no attributes with one of those two names is found, null will be returned.
    
    Parameters:
    
    element - The element to retrieve the ID value from.
    
    type - The settings type of the specified element that can be retrieved with the code getModel().getType(element).
    
    model - The settings model that owns the specified element. If those settings are not a settings manager, this parameter is equal to getModel(). Otherwise, this parameter authorizes the settings manager for introspection of the values of the specified element.
    
    Returns:
    
    The ID value of the specified element or null if the element does not have an ID.
    
    See Also:
    
    getID(Object), setID(java.lang.Object, java.lang.Object, java.lang.String, IlvMutableSettingsModel), addIDResolver(ilog.views.appframe.settings.IlvSettings.IDResolver), removeIDResolver(ilog.views.appframe.settings.IlvSettings.IDResolver)
  - getID
```
public Object getID(Object element)
```
    Returns the ID value for the specified settings element owned by those settings. The implementation of this method calls the method getID(java.lang.Object, java.lang.String, IlvSettingsModel) with the specified element, the settings type of this element, and the settings model of those settings respectively as the parameters.
    
    Returns:
    
    The ID value of the specified settings element.
    
    See Also:
    
    getID(Object, String, IlvSettingsModel)
  - setID
```
protected boolean setID(Object element,
                        Object id,
                        String type,
                        IlvMutableSettingsModel model)
```
    Sets the specified ID value to the specified object of the model.
    
    Parameters:
    
    element - The element to set the ID to.
    
    id - The ID value to set the specified element to.
    
    type - The type of the specified element.
    
    model - The settings model that owns the specified settings element.
    
    Returns:
    
    true if the ID value could be set to the element or false if no ID is defined for the specified type.
    
    See Also:
    
    getID(java.lang.Object, java.lang.String, IlvSettingsModel)
  - addIDResolver
```
public void addIDResolver(IlvSettings.IDResolver resolver)
```
    Adds the specified ID resolver for providing ID attributes for new settings types.
    
    Parameters:
    
    resolver - The resolver to add.
    
    See Also:
    
    removeIDResolver(ilog.views.appframe.settings.IlvSettings.IDResolver), IlvSettings.IDResolver
  - removeIDResolver
```
public boolean removeIDResolver(IlvSettings.IDResolver resolver)
```
    Removes the specified ID resolver from the list of mappers stored in those settings.
    
    Returns:
    
    true if this resolver was added to those settings; false otherwise.
    
    See Also:
    
    addIDResolver(ilog.views.appframe.settings.IlvSettings.IDResolver)
  - selectElement
```
public IlvSettingsElement selectElement(IlvSettingsQuery query)
```
    Returns the first settings element selected by the specified query.
    
    Parameters:
    
    query - The query.
    
    Returns:
    
    The first settings element that matches the specified query or null if no settings elements could be found.
    
    See Also:
    
    IlvSettingsQuery, IlvSettingsElement, IlvSettingsManager
  - selectElement
```
public IlvSettingsElement selectElement(String type,
                                        String attributeName,
                                        Object attributeValue)
```
    Returns the first root settings element selected by the specified query parameters.
    Root elements with the specified type are first selected. The first element of this selection with the value of the attribute attributeName equal to attributeValue is returned.
    
    Parameters:
    
    type - The type of the element to retrieve.
    
    attributeName - The name of the attribute to match the value of.
    
    attributeValue - The value of the attribute to compare.
    
    Returns:
    
    The first settings element that matches the specified query or null if no settings elements could be found.
    
    See Also:
    
    IlvSettingsQuery, IlvSettingsElement, IlvSettingsManager
  - selectElement
```
public IlvSettingsElement selectElement(String type)
```
    Returns the first root settings element with the specified type.
    
    Parameters:
    
    type - The type of the element to retrieve.
    
    Returns:
    
    The first settings element with the settings type or null if no elements are found.
    
    See Also:
    
    IlvSettingsQuery, IlvSettingsElement.getFirstChild(java.lang.String)
  - select
```
public IlvSettingsElement[] select(IlvSettingsQuery query)
```
    Returns the settings elements selected by the specified query.
    
    Parameters:
    
    query - The query.
    
    Returns:
    
    The array of settings elements that match the specified query.
    
    See Also:
    
    IlvSettingsQuery, IlvSettingsElement
  - selectNodes
```
public IlvSettingsNode[] selectNodes(IlvSettingsQuery query)
```
    Returns the settings nodes selected by the specified query.
    The selected nodes can be either IlvSettingsElement or IlvSettingsAttribute instances.
    
    Parameters:
    
    query - The query.
    
    Returns:
    
    The array of selected settings nodes.
    
    See Also:
    
    IlvSettingsQuery, IlvSettingsElement, IlvSettingsAttribute
  - select
```
public IlvSettingsElement[] select(String type,
                                   IlvSettingsElement[] contextElements)
```
    Returns the settings elements with the specified settings type and children of the specified contextElements.
    
    Parameters:
    
    type - The type of the settings elements to return.
    
    contextElements - The elements to start the selection from. If this array is null, the root settings elements of those settings with the specified type will be returned.
    
    Returns:
    
    The array of settings elements.
    
    See Also:
    
    IlvSettingsQuery, IlvSettingsElement, IlvSettingsManager
  - select
```
public IlvSettingsElement[] select(IlvSettingsQuery query,
                                   IlvSettingsElement[] contextElements)
```
    Returns the settings elements selected by the specified query from the specified settings element.
    
    Parameters:
    
    query - The query that selects the elements to retrieve.
    
    contextElements - The elements to start the selection from. If null, the selection will start from the root elements of all the settings added to the application.
    
    Returns:
    
    A set of nodes that matches the given query.
  - ensureSettingsElement
```
public IlvSettingsElement ensureSettingsElement(IlvSettingsQuery query)
```
    Ensures that a settings element of those settings is selectable from the specified query. If no settings element could be selected from the query, the method attempts to create a new settings element and add it to the settings so that it can be selectable from the specified query.
    
    Parameters:
    
    query - The settings query that selects the returned element.
    
    Returns:
    
    The settings element that is selected from the query or null if no settings element could be found and if no settings element could be created from the specified query.
    
    See Also:
    
    selectElement(IlvSettingsQuery), ensureSettingsElement(String), IlvSettingsElement.ensureChildElement(IlvSettingsQuery)
  - ensureSettingsElement
```
public IlvSettingsElement ensureSettingsElement(String type)
```
    Ensures that a root settings element with the specified type exists in those settings. If no root element could be found with the specified type, a new settings element is created with this type and added as a root element of those settings.
    
    Parameters:
    
    type - The type of the root settings element to retrieve.
    
    Returns:
    
    The root settings element with the specified type.
    
    See Also:
    
    ensureSettingsElement(IlvSettingsQuery), IlvSettingsElement.ensureChildElement(String)
  - getCascadingMode
```
public short getCascadingMode()
```
    Specifies how the content of those settings should be merged with other settings if those settings are inserted into an IlvSettingsManager manager. This mode can have one of the following values:
    - SET_MODE The data of those settings erase data with the same keys defined in settings of lower priority.
    - APPLY_DIFF_MODE The data of those settings must be merged with data defined in settings of lower priority, when both lots of data have the same key.
    See Also:
    
    setCascadingMode(short)
  - setCascadingMode
```
public void setCascadingMode(short mode)
```
    Sets the cascading mode of those settings with other settings.
    Parameters:
    mode - The new cascading mode. Can be one of the following values:
    
    SET_MODE
    
    APPLY_DIFF_MODE
    See Also:
    
    getCascadingMode()
  - createSettingsElement
```
public IlvSettingsElement createSettingsElement(String type)
```
    Creates a new element with the specified type.
    
    Returns:
    
    The newly created element or null if those settings do not support the specified type.
  - removeSettingsElement
```
public boolean removeSettingsElement(IlvSettingsElement element)
```
    Removes the model element of the settings referenced by the specified settings element.
    
    Parameters:
    
    element - The settings element to remove.
    
    Returns:
    
    true if the element could be removed; false otherwise.
    
    See Also:
    
    addSettingsElement(ilog.views.appframe.settings.IlvSettingsElement, ilog.views.appframe.settings.IlvSettingsElement, int)
  - addSettingsElement
```
public void addSettingsElement(IlvSettingsElement parentElement,
                               IlvSettingsElement element,
                               int index)
```
    Adds the specified element to the specified parent.
    
    Parameters:
    
    parentElement - The settings element to add a child to.
    
    element - The settings element to add.
    
    index - The insertion index.
    
    See Also:
    
    removeSettingsElement(ilog.views.appframe.settings.IlvSettingsElement)
  - removeAllSettingsElements
```
public boolean removeAllSettingsElements(IlvSettingsElement parent,
                                         String type)
```
    Removes all the settings elements that are children of the specified parent element and have the specified type.
    
    Parameters:
    
    parent - The parent element to remove child elements from. If null, all the root elements of those settings with the specified type will be removed.
    
    type - The settings type of the elements to remove. If null, all the child elements will be removed.
    
    Returns:
    
    true if all the child elements could be removed; false otherwise.
  - ensureCorrespondingElement
```
public Object ensureCorrespondingElement(IlvSettingsElement element)
```
    Ensures that the specified settings element has a cascaded element in these settings.
    
    Parameters:
    
    element - The settings element to make corresponding in these settings.
    
    Returns:
    
    The element of the model of these settings that match the specified settings element.
    
    Since:
    
    JViews 6.0
  - createModel
```
protected IlvSettingsModel createModel(short accessRights)
```
    Creates the model of those settings. This method is called when settings are about to be read or modified and no model has yet been set.
    Creating the model when overriding this method allows for creating the model when needed the first time. If this Load on demand mechanism is not necessary, the model can be created with those settings and set using the setModel(ilog.views.appframe.settings.IlvSettingsModel) method.
    If the accessRights parameter contains the WRITABLE tag, it is possible that a model has already been created and set to those settings, if this model does not implement the IlvMutableSettingsModel interface.
    
    Parameters:
    
    accessRights - The type of access that this model is required for. If (accessRigths & WRITABLE) != 0 or if the model is intended to be accessed in Write mode, it has to implement the IlvMutableSettingsModel interface.
    
    Returns:
    
    The newly created settings model. By default, null is returned
  - getDoctype
```
public DocumentType getDoctype()
```
    The Document Type Declaration (see DocumentType) associated with this document. For HTML documents as well as XML documents without a document type declaration this returns null. The DOM Level 2 does not support editing the Document Type Declaration. docType cannot be altered in any way, including through the use of methods inherited from the Node interface, such as insertNode or removeNode.
    
    Specified by:
    
    getDoctype in interface Document
    
    Returns:
    
    The implementation of this method returns null. It is overridden by the IlvXMLSettings class to return the document type of the associated DOM document.
    
    See Also:
    
    IlvXMLSettings.getDoctype()
  - getImplementation
```
public DOMImplementation getImplementation()
```
    The DOMImplementation object that handles this document. A DOM application may use objects from multiple implementations.
    
    Specified by:
    
    getImplementation in interface Document
    
    Returns:
    
    The implementation of this method returns null. It is overridden by the IlvXMLSettings class to return the document implementation of the associated DOM document.
    
    See Also:
    
    IlvXMLSettings.getImplementation()
  - getDocumentElement
```
public Element getDocumentElement()
```
    This is a convenience attribute that allows direct access to the child node that is the root element of the document. For HTML documents, this is the element with the tagName "HTML".
    
    Specified by:
    
    getDocumentElement in interface Document
    
    Returns:
    
    The first element selected by the method selectElement(java.lang.String, java.lang.String, java.lang.Object) with null given for all the parameters. If no element is selected, this method returns null.
    
    See Also:
    
    IlvXMLSettings.getDocumentElement()
  - createElement
```
public Element createElement(String tagName)
                      throws DOMException
```
    Creates an element of the type specified. Note that the instance returned implements the Element interface, so attributes can be specified directly on the returned object.
    In addition, if there are known attributes with default values, Attr nodes representing them are automatically created and attached to the element.
    To create an element with a qualified name and namespace URI, use the createElementNS method.
    This method has the same behavior than the method createSettingsElement(java.lang.String).
    
    Specified by:
    
    createElement in interface Document
    
    Parameters:
    
    tagName - The name of the element type to instantiate. For XML, this is case-sensitive. For HTML, the tagName parameter may be provided in any case, but it must be mapped to the canonical uppercase form by the DOM implementation.
    
    Returns:
    
    A new Element object with the nodeName attribute set to tagName, and localName, prefix, and namespaceURI set to null.
    
    Throws:
    
    DOMException - INVALID_CHARACTER_ERR: Raised if the specified name contains an illegal character.
    
    See Also:
    
    createSettingsElement(java.lang.String)
  - createDocumentFragment
```
public DocumentFragment createDocumentFragment()
```
    Creates an empty DocumentFragment object.
    
    Specified by:
    
    createDocumentFragment in interface Document
    
    Returns:
    
    The implementation of this method returns null. It is overridden by the IlvXMLSettings class to return a new document fragment created by the associated DOM document.
    
    See Also:
    
    IlvXMLSettings.createDocumentFragment()
  - createTextNode
```
public Text createTextNode(String data)
```
    Creates a Text node given the specified string.
    
    Specified by:
    
    createTextNode in interface Document
    
    Parameters:
    
    data - The data for the node.
    
    Returns:
    
    The implementation of this method returns null. It is overridden by the IlvXMLSettings class to return a new Text created by the associated DOM document.
    
    See Also:
    
    IlvXMLSettings.createTextNode(java.lang.String)
  - createComment
```
public Comment createComment(String data)
```
    Creates a Comment node given the specified string.
    
    Specified by:
    
    createComment in interface Document
    
    Parameters:
    
    data - The data for the node.
    
    Returns:
    
    The implementation of this method returns null. It is overridden by the IlvXMLSettings class to return a new comment created by the associated DOM document.
    
    See Also:
    
    IlvXMLSettings.createComment(java.lang.String)
  - createCDATASection
```
public CDATASection createCDATASection(String data)
                                throws DOMException
```
    Creates a CDATASection node whose value is the specified string.
    
    Specified by:
    
    createCDATASection in interface Document
    
    Parameters:
    
    data - The data for the CDATASection contents.
    
    Returns:
    
    The implementation of this method returns null. It is overridden by the IlvXMLSettings class to return a new CDATASection object created by the associated DOM document.
    
    Throws:
    
    DOMException - NOT_SUPPORTED_ERR: Raised if this document is an HTML document.
    
    See Also:
    
    IlvXMLSettings.createCDATASection(java.lang.String)
  - createProcessingInstruction
```
public ProcessingInstruction createProcessingInstruction(String target,
                                                         String data)
                                                  throws DOMException
```
    Creates a ProcessingInstruction node given the specified name and data strings.
    
    Specified by:
    
    createProcessingInstruction in interface Document
    
    Parameters:
    
    target - The target part of the processing instruction.
    
    data - The data for the node.
    
    Returns:
    
    The implementation of this method returns null. It is overridden by the IlvXMLSettings class to return a new ProcessingInstruction object created by the associated DOM document.
    
    Throws:
    
    DOMException - INVALID_CHARACTER_ERR: Raised if the specified target contains an illegal character.
    NOT_SUPPORTED_ERR: Raised if this document is an HTML document.
    
    See Also:
    
    IlvXMLSettings.createProcessingInstruction(java.lang.String, java.lang.String)
  - createAttribute
```
public Attr createAttribute(String name)
                     throws DOMException
```
    Creates an Attr of the given name. Note that the Attr instance can then be set on an Element using the setAttributeNode method.
    To create an attribute with a qualified name and namespace URI, use the createAttributeNS method.
    
    Specified by:
    
    createAttribute in interface Document
    
    Parameters:
    
    name - The name of the attribute.
    
    Returns:
    
    The implementation of this method returns null. It is overridden by the IlvXMLSettings class to return a new Attr object created by the associated DOM document.
    
    Throws:
    
    DOMException - INVALID_CHARACTER_ERR: Raised if the specified name contains an illegal character.
    
    See Also:
    
    IlvXMLSettings.createAttribute(java.lang.String)
  - createEntityReference
```
public EntityReference createEntityReference(String name)
                                      throws DOMException
```
    Creates an EntityReference object. In addition, if the referenced entity is known, the child list of the EntityReference node is made the same as that of the corresponding Entity node.If any descendant of the Entity node has an unbound namespace prefix, the corresponding descendant of the created EntityReference node is also unbound; (its namespaceURI is null). The DOM Level 2 does not support any mechanism to resolve namespace prefixes.
    
    Specified by:
    
    createEntityReference in interface Document
    
    Parameters:
    
    name - The name of the entity to reference.
    
    Returns:
    
    The implementation of this method returns null. It is overridden by the IlvXMLSettings class to return a new EntityReference object created by the associated DOM document.
    
    Throws:
    
    DOMException - INVALID_CHARACTER_ERR: Raised if the specified name contains an illegal character.
    NOT_SUPPORTED_ERR: Raised if this document is an HTML document.
    
    See Also:
    
    IlvXMLSettings.createEntityReference(java.lang.String)
  - getElementsByTagName
```
public NodeList getElementsByTagName(String tagname)
```
    Returns a NodeList of all the Elements with a given tag name in the order in which they are encountered in a preorder traversal of the Document tree.
    This method is equivalent to the method select(java.lang.String, ilog.views.appframe.settings.IlvSettingsElement[]) with tagname given as the first parameter and null as the second.
    
    Specified by:
    
    getElementsByTagName in interface Document
    
    Parameters:
    
    tagname - The name of the tag to match on. The special value "*" matches all tags.
    
    Returns:
    
    A new NodeList object containing all the matched Elements.
  - importNode
```
public Node importNode(Node importedNode,
                       boolean deep)
                throws DOMException
```
    Imports a node from another document to this document. The implementation of this method is empty. It is overridden by the IlvXMLSettings class to import a node the associated DOM document.
    
    Specified by:
    
    importNode in interface Document
    
    Parameters:
    
    importedNode - The node to import.
    
    deep - If true, recursively import the subtree under the specified node; if false, import only the node itself, as explained above. This has no effect on Attr , EntityReference, and Notation nodes.
    
    Returns:
    
    The implementation of this method returns null.
    
    Throws:
    
    DOMException - NOT_SUPPORTED_ERR: Raised if the type of node being imported is not supported.
    
    Since:
    
    DOM Level 2
    
    See Also:
    
    IlvXMLSettings.importNode(org.w3c.dom.Node, boolean)
  - createElementNS
```
public Element createElementNS(String namespaceURI,
                               String qualifiedName)
                        throws DOMException
```
    Creates an element of the given qualified name and namespace URI. The implementation of this method creates an element by invoking the createSettingsElement(java.lang.String) method with the result of the concatenation of namespaceURI and qualifiedName as the parameter.
    The IlvXMLSettings class overrides this method to make the associated DOM document create the element.
    
    Specified by:
    
    createElementNS in interface Document
    
    Parameters:
    
    namespaceURI - The namespace URI of the element to create.
    
    qualifiedName - The qualified name of the element type to instantiate.
    
    Returns:
    
    A new Element object with the following attributes:AttributeValueNode.nodeName qualifiedNameNode.namespaceURI namespaceURINode.prefixprefix, extracted from qualifiedName, or null if there is no prefixNode.localNamelocal name, extracted from qualifiedNameElement.tagName qualifiedName
    
    Throws:
    
    DOMException - INVALID_CHARACTER_ERR: Raised if the specified qualified name contains an illegal character.
    NAMESPACE_ERR: Raised if the qualifiedName is malformed, if the qualifiedName has a prefix and the namespaceURI is null, or if the qualifiedName has a prefix that is "xml" and the namespaceURI is different from " http://www.w3.org/XML/1998/namespace" .
    
    Since:
    
    DOM Level 2
  - createAttributeNS
```
public Attr createAttributeNS(String namespaceURI,
                              String qualifiedName)
                       throws DOMException
```
    Creates an attribute of the given qualified name and namespace URI. The implementation of this method returns null.
    The IlvXMLSettings class overrides this method to make the associated DOM document create the attribute.
    
    Specified by:
    
    createAttributeNS in interface Document
    
    Parameters:
    
    namespaceURI - The namespace URI of the attribute to create.
    
    qualifiedName - The qualified name of the attribute to instantiate.
    
    Returns:
    
    A new Attr object with the following attributes: AttributeValueNode.nodeNamequalifiedName Node.namespaceURInamespaceURI Node.prefixprefix, extracted from qualifiedName, or null if there is no prefixNode.localNamelocal name, extracted from qualifiedNameAttr.name qualifiedNameNode.nodeValuethe empty string
    
    Throws:
    
    DOMException - INVALID_CHARACTER_ERR: Raised if the specified qualified name contains an illegal character.
    NAMESPACE_ERR: Raised if the qualifiedName is malformed, if the qualifiedName has a prefix and the namespaceURI is null, if the qualifiedName has a prefix that is "xml" and the namespaceURI is different from " http://www.w3.org/XML/1998/namespace", or if the qualifiedName is "xmlns" and the namespaceURI is different from " http://www.w3.org/2000/xmlns/".
    
    Since:
    
    DOM Level 2
  - getElementsByTagNameNS
```
public NodeList getElementsByTagNameNS(String namespaceURI,
                                       String localName)
```
    Returns a NodeList of all the Elements with a given local name and namespace URI in the order in which they are encountered in a preorder traversal of the Document tree.
    
    Specified by:
    
    getElementsByTagNameNS in interface Document
    
    Parameters:
    
    namespaceURI - The namespace URI of the elements to match on. The special value "*" matches all namespaces.
    
    localName - The local name of the elements to match on. The special value "*" matches all local names.
    
    Returns:
    
    A new NodeList object containing all the matched Elements.
    
    Since:
    
    DOM Level 2
  - getElementById
```
public Element getElementById(String elementId)
```
    Returns the Element whose ID is given by elementId. If no such element exists, returns null. Behavior is not defined if more than one element has this ID. The DOM implementation must have information that says which attributes are of type ID. Attributes with the name "ID" are not of type ID unless so defined. Implementations that do not know whether attributes are of type ID or not are expected to return null.
    
    Specified by:
    
    getElementById in interface Document
    
    Parameters:
    
    elementId - The unique id value for an element.
    
    Returns:
    
    The null as this default implementation does not support this feature. The IlvXMLSettings class overrides this method to return the matching element in the associated DOM document.
    
    Since:
    
    DOM Level 2
    
    See Also:
    
    IlvXMLSettings.getElementById(java.lang.String)
  - getNodeName
```
public String getNodeName()
```
    The name of this node.
    
    Specified by:
    
    getNodeName in interface Node
    
    Returns:
    
    The string #document as this node is a document.
  - getNodeValue
```
public String getNodeValue()
                    throws DOMException
```
    null as this node is a document and has not associated value.
    
    Specified by:
    
    getNodeValue in interface Node
    
    Throws:
    
    DOMException
    
    See Also:
    
    setNodeValue(java.lang.String)
  - setNodeValue
```
public void setNodeValue(String nodeValue)
                  throws DOMException
```
    Sets a value to this node. The implementation of this method is empty has documents are not associated with values.
    
    Specified by:
    
    setNodeValue in interface Node
    
    Parameters:
    
    nodeValue - This parameter is not used.
    
    Throws:
    
    DOMException
  - getNodeType
```
public short getNodeType()
```
    A code representing the type of this node.
    
    Specified by:
    
    getNodeType in interface Node
    
    Returns:
    
    Returns the Node.DOCUMENT_NODE code value.
  - getParentNode
```
public Node getParentNode()
```
    The parent of this node.
    
    Specified by:
    
    getParentNode in interface Node
    
    Returns:
    
    null has this node is a document.
  - getChildNodes
```
public NodeList getChildNodes()
```
    A NodeList that contains all children of this node. If there are no children, this is a NodeList containing no nodes.
    
    Specified by:
    
    getChildNodes in interface Node
    
    Returns:
    
    The list of elements given by a call to select(java.lang.String, ilog.views.appframe.settings.IlvSettingsElement[]) with null as the two parameters.
  - getFirstChild
```
public Node getFirstChild()
```
    The first child of this node. If there is no such node, this returns null.
    
    Specified by:
    
    getFirstChild in interface Node
    
    See Also:
    
    getChildNodes()
  - getLastChild
```
public Node getLastChild()
```
    The last child of this node. If there is no such node, this returns null.
    
    Specified by:
    
    getLastChild in interface Node
  - getPreviousSibling
```
public Node getPreviousSibling()
```
    The node immediately preceding this node. If there is no such node, this returns null.
    
    Specified by:
    
    getPreviousSibling in interface Node
    
    Returns:
    
    null as a Document node has no siblings.
  - getNextSibling
```
public Node getNextSibling()
```
    The node immediately following this node. If there is no such node, this returns null.
    
    Specified by:
    
    getNextSibling in interface Node
    
    Returns:
    
    null as a Document node has no siblings.
  - getAttributes
```
public NamedNodeMap getAttributes()
```
    Returns null as a document has no attributes.
    
    Specified by:
    
    getAttributes in interface Node
  - getOwnerDocument
```
public Document getOwnerDocument()
```
    The Document object associated with this node. This is also the Document object used to create new nodes. When this node is a Document or a DocumentType which is not used with any Document yet, this is null.
    
    Specified by:
    
    getOwnerDocument in interface Node
    
    Returns:
    
    null as this node is a document.
    
    Since:
    
    DOM Level 2
  - insertBefore
```
public Node insertBefore(Node newChild,
                         Node refChild)
                  throws DOMException
```
    Inserts the node newChild before the existing child node refChild. If refChild is null, insert newChild at the end of the list of children.
    If newChild is a DocumentFragment object, all of its children are inserted, in the same order, before refChild. If the newChild is already in the tree, it is first removed.
    
    Specified by:
    
    insertBefore in interface Node
    
    Parameters:
    
    newChild - The node to insert.
    
    refChild - The reference node, i.e., the node before which the new node must be inserted.
    
    Returns:
    
    The node being inserted.
    
    Throws:
    
    DOMException - HIERARCHY_REQUEST_ERR: Raised if this node is of a type that does not allow children of the type of the newChild node, or if the node to insert is one of this node's ancestors.
    WRONG_DOCUMENT_ERR: Raised if newChild was created from a different document than the one that created this node.
    NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly or if the parent of the node being inserted is readonly.
    NOT_FOUND_ERR: Raised if refChild is not a child of this node.
  - replaceChild
```
public Node replaceChild(Node newChild,
                         Node oldChild)
                  throws DOMException
```
    Replaces the child node oldChild with newChild in the list of children, and returns the oldChild node.
    If newChild is a DocumentFragment object, oldChild is replaced by all of the DocumentFragment children, which are inserted in the same order. If the newChild is already in the tree, it is first removed.
    
    Specified by:
    
    replaceChild in interface Node
    
    Parameters:
    
    newChild - The new node to put in the child list.
    
    oldChild - The node being replaced in the list.
    
    Returns:
    
    The node replaced.
    
    Throws:
    
    DOMException - HIERARCHY_REQUEST_ERR: Raised if this node is of a type that does not allow children of the type of the newChild node, or if the node to put in is one of this node's ancestors.
    WRONG_DOCUMENT_ERR: Raised if newChild was created from a different document than the one that created this node.
    NO_MODIFICATION_ALLOWED_ERR: Raised if this node or the parent of the new node is readonly.
    NOT_FOUND_ERR: Raised if oldChild is not a child of this node.
  - removeChild
```
public Node removeChild(Node oldChild)
                 throws DOMException
```
    Removes the child node indicated by oldChild from the list of children, and returns it.
    
    Specified by:
    
    removeChild in interface Node
    
    Parameters:
    
    oldChild - The node being removed.
    
    Returns:
    
    The node removed.
    
    Throws:
    
    DOMException - NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
    NOT_FOUND_ERR: Raised if oldChild is not a child of this node.
  - appendChild
```
public Node appendChild(Node newChild)
                 throws DOMException
```
    Adds the node newChild to the end of the list of children of this node. If the newChild is already in the tree, it is first removed.
    
    Specified by:
    
    appendChild in interface Node
    
    Parameters:
    
    newChild - The node to add.If it is a DocumentFragment object, the entire contents of the document fragment are moved into the child list of this node
    
    Returns:
    
    The node added.
    
    Throws:
    
    DOMException - HIERARCHY_REQUEST_ERR: Raised if this node is of a type that does not allow children of the type of the newChild node, or if the node to append is one of this node's ancestors.
    WRONG_DOCUMENT_ERR: Raised if newChild was created from a different document than the one that created this node.
    NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
  - hasChildNodes
```
public boolean hasChildNodes()
```
    Returns whether this node has any children.
    
    Specified by:
    
    hasChildNodes in interface Node
    
    Returns:
    
    true if this node has any children, false otherwise.
  - cloneNode
```
public Node cloneNode(boolean deep)
```
    Returns a duplicate of this node, i.e., serves as a generic copy constructor for nodes. The duplicate node has no parent; ( parentNode is null.).
    Cloning an Element copies all attributes and their values, including those generated by the XML processor to represent defaulted attributes, but this method does not copy any text it contains unless it is a deep clone, since the text is contained in a child Text node. Cloning an Attribute directly, as opposed to be cloned as part of an Element cloning operation, returns a specified attribute ( specified is true). Cloning any other type of node simply returns a copy of this node.
    Note that cloning an immutable subtree results in a mutable copy, but the children of an EntityReference clone are readonly . In addition, clones of unspecified Attr nodes are specified. And, cloning Document, DocumentType, Entity, and Notation nodes is implementation dependent.
    
    Specified by:
    
    cloneNode in interface Node
    
    Parameters:
    
    deep - If true, recursively clone the subtree under the specified node; if false, clone only the node itself (and its attributes, if it is an Element).
    
    Returns:
    
    The duplicate node.
  - normalize
```
public void normalize()
```
    Puts all Text nodes in the full depth of the sub-tree underneath this Node, including attribute nodes, into a "normal" form where only structure (e.g., elements, comments, processing instructions, CDATA sections, and entity references) separates Text nodes, i.e., there are neither adjacent Text nodes nor empty Text nodes. This can be used to ensure that the DOM view of a document is the same as if it were saved and re-loaded, and is useful when operations (such as XPointer lookups) that depend on a particular document tree structure are to be used.In cases where the document contains CDATASections, the normalize operation alone may not be sufficient, since XPointers do not differentiate between Text nodes and CDATASection nodes.
    
    Specified by:
    
    normalize in interface Node
    
    Since:
    
    DOM Level 2
  - isSupported
```
public boolean isSupported(String feature,
                           String version)
```
    Tests whether the DOM implementation implements a specific feature and that feature is supported by this node. The implementation of this method always returns false. It is overridden by the IlvXMLSettings class to return features supported by the DOM implementation of the associated DOM document.
    
    Specified by:
    
    isSupported in interface Node
    
    Parameters:
    
    feature - The name of the feature to test. This is the same name which can be passed to the method hasFeature on DOMImplementation.
    
    version - This is the version number of the feature to test. In Level 2, version 1, this is the string "2.0". If the version is not specified, supporting any version of the feature will cause the method to return true.
    
    Returns:
    
    Returns true if the specified feature is supported on this node, false otherwise.
    
    Since:
    
    DOM Level 2
  - getNamespaceURI
```
public String getNamespaceURI()
```
    Implementation of the method Node.getNamespaceURI() method. Always returns null as documents do not support namespaces.
    
    Specified by:
    
    getNamespaceURI in interface Node
    
    Since:
    
    DOM Level 2
  - getPrefix
```
public String getPrefix()
```
    Implementation of the method Node.getPrefix() method. Always returns null as documents do not support prefixes.
    
    Specified by:
    
    getPrefix in interface Node
    
    Throws:
    
    DOMException - INVALID_CHARACTER_ERR: Raised if the specified prefix contains an illegal character.
    NO_MODIFICATION_ALLOWED_ERR: Raised if this node is readonly.
    NAMESPACE_ERR: Raised if the specified prefix is malformed, if the namespaceURI of this node is null, if the specified prefix is "xml" and the namespaceURI of this node is different from " http://www.w3.org/XML/1998/namespace", if this node is an attribute and the specified prefix is "xmlns" and the namespaceURI of this node is different from " http://www.w3.org/2000/xmlns/", or if this node is an attribute and the qualifiedName of this node is "xmlns" .
    
    Since:
    
    DOM Level 2
  - setPrefix
```
public void setPrefix(String prefix)
               throws DOMException
```
    This method has no effects as documents do not support prefixes.
    
    Specified by:
    
    setPrefix in interface Node
    
    Parameters:
    
    prefix - This parameter is not used.
    
    Throws:
    
    DOMException
  - getLocalName
```
public String getLocalName()
```
    Returns the local part of the qualified name of this node. The implementation of this method returns null as document do not have local names.
    
    Specified by:
    
    getLocalName in interface Node
    
    Since:
    
    DOM Level 2
  - hasAttributes
```
public boolean hasAttributes()
```
    Returns whether this node (if it is an element) has any attributes.
    
    Specified by:
    
    hasAttributes in interface Node
    
    Returns:
    
    false has documents do not have attributes.
    
    Since:
    
    DOM Level 2
  - IsEveryNodeKey
```
public static boolean IsEveryNodeKey(String key)
```
    Determines whether the specified key selects all the nodes if used in a query.
    
    Returns:
    
    true if the specified key is null or equal to EVERY_NODE_KEY; false otherwise.

Class IlvSettings

Nested Class Summary

Field Summary

Fields inherited from interface org.w3c.dom.Node

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

WRITABLE

READABLE

UNREADABLE

SET_MODE

APPLY_DIFF_MODE

EVERY_NODE_KEY

VERBOSE

Constructor Detail

IlvSettings

IlvSettings

IlvSettings

Method Detail

getBaseURI

compareDocumentPosition

getTextContent

setTextContent

isSameNode

lookupPrefix

isDefaultNamespace

lookupNamespaceURI

isEqualNode

getFeature

setUserData

getUserData

getInputEncoding

getXmlEncoding

getXmlStandalone

setXmlStandalone

getXmlVersion

setXmlVersion

getStrictErrorChecking

setStrictErrorChecking

getDocumentURI

setDocumentURI

adoptNode

getDomConfig

normalizeDocument

renameNode

getName

setName

initializeSettings

areSettingsInitialized

setModel

getModel

getMutableModel

getSettingsManager

setSettingsManager

setApplication

getApplication

commit

getAccessRights

setAccessRights

canWrite

getID

getID

setID

addIDResolver

removeIDResolver

selectElement

selectElement

selectElement

select

selectNodes

select

select

ensureSettingsElement

ensureSettingsElement

getCascadingMode

setCascadingMode

createSettingsElement

removeSettingsElement

addSettingsElement