IfsSimpleXmlParser (ecmsdk-api 3.4.0 API)

java.lang.Object
- oracle.ifs.beans.parsers.IfsSimpleXmlParser

All Implemented Interfaces:

XmlParserInterface
```
public class IfsSimpleXmlParser
extends Object
implements XmlParserInterface
```
The IfsSimpleXmlParser creates LibraryObjects by traversing the DOM tree.
The parser defines a simple mapping between XML tags and iFS objects.
The parser is the reverse of the SimpleXmlRenderer. Output from the SimpleXmlRenderer can be run through the IfsSimpleXmlParser to re-create the relevant objects.

(Unpublished)

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`ACCESS_LEVEL_TAG`
`static String`	`ACES_TAG`
`static String`	`ACTION_ATTRIBUTE`
`static String`	`ADD_ACTION`
`static String`	`ARRAY_ELEMENT_TAG`
`static String`	`ATTRIBUTES_TAG`
`static String`	`CATEGORIES_TAG`
`static String`	`CLASSNAME_ATTRIBUTE`
`static String`	`CONTENT_TAG`
`static String`	`DATATYPE_ATTRIBUTE`
`static String`	`DATATYPE_TAG`
`static String`	`DEFINITION_ATTRIBUTE`
`static String`	`DOMAINTYPE_ATTRIBUTE`
`static String`	`FOLDER_PATH_TAG`
`static String`	`FORMAT_ATTRIBUTE`
`static String`	`FORMAT_TAG`
`static String`	`GRANTEE_TAG`
`static String`	`IGNORE_UNSETTABLE_OPTION` If set to true in options table, parser will ignore all attributes in the XML document which are marked as "unsettable".
`protected String`	`m_CharacterEncoding` The character encoding information stored in
`protected InputStream`	`m_InputStream` The InputStream representing the XML document
`protected IfsXmlParser`	`m_Parser` The IfsXmlParser
`protected Reader`	`m_Reader` The Reader representing the XML document
`protected LibrarySession`	`m_Session` The LibrarySession which constructed this XmlParser
`static String`	`MEDIA_TAG`
`static String`	`MEMBERS_TAG`
`static String`	`OBJECT_LIST_TAG`
`static String`	`OPTIONS_TAG`
`static String`	`PASSWORD_TAG`
`static String`	`PERMISSIONBUNDLES_TAG`
`static String`	`POLICIES_TAG`
`static String`	`POLICY_TAG`
`static String`	`PROPERTIES_TAG`
`static String`	`PROPERTY_VALUE_TAG`
`static String`	`REFERENCE_BY_EXISTING`
`static String`	`REFERENCE_BY_ID`
`static String`	`REFERENCE_BY_NAME`
`static String`	`REFERENCE_BY_PATH`
`static String`	`REFERENCE_BY_VALUEDEFAULT`
`static String`	`REFERENCE_TYPE_ATTRIBUTE`
`static String`	`REMOVE_ACTION`
`static String`	`SIMPLE_USER_TAG`
`static String`	`UPDATE_TAG`
`static String`	`VALUEDEFAULT_VALUE_TAG`
`static String`	`VALUEDOMAIN_VALUE_TAG`

Constructor Summary

Constructors
Constructor and Description

IfsSimpleXmlParser(LibrarySession session)
Constructs a IfsSimpleXmlParser

Constructors
Constructor and Description
`IfsSimpleXmlParser(LibrarySession session)` Constructs a IfsSimpleXmlParser

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected SimpleXmlParserImpl`	`getImplementation(ParserCallback callback, Hashtable options)` Creates a SimpleXmlParserImpl to parse the document with.
`protected LibraryObjectDefinition`	`handleUnknownTag(Element unknownElement, LibraryObjectDefinition lod)` Handles an unknown tag.
`LibraryObject`	`parse(IfsXmlParser ifsxmlparser, InputStream stream, ParserCallback callback, Hashtable options)` Parses the specified InputStream representing an XML document.
`LibraryObject`	`parse(IfsXmlParser ifsxmlparser, Reader reader, ParserCallback callback, Hashtable options)` Parses the specified Reader representing an XML document.
`protected LibraryObject`	`traverseTree(Document doc, ParserCallback callback, Hashtable options)` Traverses the DOM tree and creates the appropriate LibraryObjects.

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

- Field Detail
  - IGNORE_UNSETTABLE_OPTION
```
public static final String IGNORE_UNSETTABLE_OPTION
```
    If set to true in options table, parser will ignore all attributes in the XML document which are marked as "unsettable".
    
    See Also:
    
    Constant Field Values
    
    (Unpublished)
  - SIMPLE_USER_TAG
```
public static final String SIMPLE_USER_TAG
```
    See Also:
    
    Constant Field Values
    
    (Unpublished)
  - OBJECT_LIST_TAG
```
public static final String OBJECT_LIST_TAG
```
    See Also:
    
    Constant Field Values
    
    (Unpublished)
  - ARRAY_ELEMENT_TAG
```
public static final String ARRAY_ELEMENT_TAG
```
    See Also:
    
    Constant Field Values
    
    (Unpublished)
  - CATEGORIES_TAG
```
public static final String CATEGORIES_TAG
```
    See Also:
    
    Constant Field Values
    
    (Unpublished)
  - FOLDER_PATH_TAG
```
public static final String FOLDER_PATH_TAG
```
    See Also:
    
    Constant Field Values
    
    (Unpublished)
  - UPDATE_TAG
```
public static final String UPDATE_TAG
```
    See Also:
    
    Constant Field Values
    
    (Unpublished)
  - OPTIONS_TAG
```
public static final String OPTIONS_TAG
```
    See Also:
    
    Constant Field Values
    
    (Unpublished)
  - POLICIES_TAG
```
public static final String POLICIES_TAG
```
    See Also:
    
    Constant Field Values
    
    (Unpublished)
  - POLICY_TAG
```
public static final String POLICY_TAG
```
    See Also:
    
    Constant Field Values
    
    (Unpublished)
  - MEMBERS_TAG
```
public static final String MEMBERS_TAG
```
    See Also:
    
    Constant Field Values
    
    (Unpublished)
  - PROPERTIES_TAG
```
public static final String PROPERTIES_TAG
```
    See Also:
    
    Constant Field Values
    
    (Unpublished)
  - DATATYPE_TAG
```
public static final String DATATYPE_TAG
```
    See Also:
    
    Constant Field Values
    
    (Unpublished)
  - DOMAINTYPE_ATTRIBUTE
```
public static final String DOMAINTYPE_ATTRIBUTE
```
    See Also:
    
    Constant Field Values
    
    (Unpublished)
  - PROPERTY_VALUE_TAG
```
public static final String PROPERTY_VALUE_TAG
```
    See Also:
    
    Constant Field Values
    
    (Unpublished)
  - CONTENT_TAG
```
public static final String CONTENT_TAG
```
    See Also:
    
    Constant Field Values
    
    (Unpublished)
  - MEDIA_TAG
```
public static final String MEDIA_TAG
```
    See Also:
    
    Constant Field Values
    
    (Unpublished)
  - FORMAT_TAG
```
public static final String FORMAT_TAG
```
    See Also:
    
    Constant Field Values
    
    (Unpublished)
  - ATTRIBUTES_TAG
```
public static final String ATTRIBUTES_TAG
```
    See Also:
    
    Constant Field Values
    
    (Unpublished)
  - ACES_TAG
```
public static final String ACES_TAG
```
    See Also:
    
    Constant Field Values
    
    (Unpublished)
  - ACCESS_LEVEL_TAG
```
public static final String ACCESS_LEVEL_TAG
```
    See Also:
    
    Constant Field Values
    
    (Unpublished)
  - GRANTEE_TAG
```
public static final String GRANTEE_TAG
```
    See Also:
    
    Constant Field Values
    
    (Unpublished)
  - PERMISSIONBUNDLES_TAG
```
public static final String PERMISSIONBUNDLES_TAG
```
    See Also:
    
    Constant Field Values
    
    (Unpublished)
  - PASSWORD_TAG
```
public static final String PASSWORD_TAG
```
    See Also:
    
    Constant Field Values
    
    (Unpublished)
  - ACTION_ATTRIBUTE
```
public static final String ACTION_ATTRIBUTE
```
    See Also:
    
    Constant Field Values
    
    (Unpublished)
  - FORMAT_ATTRIBUTE
```
public static final String FORMAT_ATTRIBUTE
```
    See Also:
    
    Constant Field Values
    
    (Unpublished)
  - DATATYPE_ATTRIBUTE
```
public static final String DATATYPE_ATTRIBUTE
```
    See Also:
    
    Constant Field Values
    
    (Unpublished)
  - DEFINITION_ATTRIBUTE
```
public static final String DEFINITION_ATTRIBUTE
```
    See Also:
    
    Constant Field Values
    
    (Unpublished)
  - CLASSNAME_ATTRIBUTE
```
public static final String CLASSNAME_ATTRIBUTE
```
    See Also:
    
    Constant Field Values
    
    (Unpublished)
  - REFERENCE_TYPE_ATTRIBUTE
```
public static final String REFERENCE_TYPE_ATTRIBUTE
```
    See Also:
    
    Constant Field Values
    
    (Unpublished)
  - REFERENCE_BY_PATH
```
public static final String REFERENCE_BY_PATH
```
    See Also:
    
    Constant Field Values
    
    (Unpublished)
  - REFERENCE_BY_ID
```
public static final String REFERENCE_BY_ID
```
    See Also:
    
    Constant Field Values
    
    (Unpublished)
  - REFERENCE_BY_NAME
```
public static final String REFERENCE_BY_NAME
```
    See Also:
    
    Constant Field Values
    
    (Unpublished)
  - REFERENCE_BY_VALUEDEFAULT
```
public static final String REFERENCE_BY_VALUEDEFAULT
```
    See Also:
    
    Constant Field Values
    
    (Unpublished)
  - VALUEDEFAULT_VALUE_TAG
```
public static final String VALUEDEFAULT_VALUE_TAG
```
    See Also:
    
    Constant Field Values
    
    (Unpublished)
  - VALUEDOMAIN_VALUE_TAG
```
public static final String VALUEDOMAIN_VALUE_TAG
```
    See Also:
    
    Constant Field Values
    
    (Unpublished)
  - REFERENCE_BY_EXISTING
```
public static final String REFERENCE_BY_EXISTING
```
    See Also:
    
    Constant Field Values
    
    (Unpublished)
  - REMOVE_ACTION
```
public static final String REMOVE_ACTION
```
    See Also:
    
    Constant Field Values
    
    (Unpublished)
  - ADD_ACTION
```
public static final String ADD_ACTION
```
    See Also:
    
    Constant Field Values
    
    (Unpublished)
  - m_Session
```
protected LibrarySession m_Session
```
    The LibrarySession which constructed this XmlParser
    
    (Unpublished)
  - m_Parser
```
protected IfsXmlParser m_Parser
```
    The IfsXmlParser
    
    (Unpublished)
  - m_InputStream
```
protected InputStream m_InputStream
```
    The InputStream representing the XML document
    
    (Unpublished)
  - m_Reader
```
protected Reader m_Reader
```
    The Reader representing the XML document
    
    (Unpublished)
  - m_CharacterEncoding
```
protected String m_CharacterEncoding
```
    The character encoding information stored in tag
    
    (Unpublished)
- Constructor Detail
  - IfsSimpleXmlParser
```
public IfsSimpleXmlParser(LibrarySession session)
```
    Constructs a IfsSimpleXmlParser
    
    Parameters:
    
    session - the LibrarySession
    
    (Unpublished)
- Method Detail
  - handleUnknownTag
```
protected LibraryObjectDefinition handleUnknownTag(Element unknownElement,
                                                   LibraryObjectDefinition lod)
                                            throws IfsException
```
    Handles an unknown tag.
    
    Parameters:
    
    unknownElement - the Element which could not be indentified
    
    lod - the LibraryObjectDefinition being processed
    
    Throws:
    
    IfsException - when operation fails
    
    (Unpublished)
  - parse
```
public LibraryObject parse(IfsXmlParser ifsxmlparser,
                           InputStream stream,
                           ParserCallback callback,
                           Hashtable options)
                    throws IfsException
```
    Description copied from interface: XmlParserInterface
    
    Parses the specified InputStream representing an XML document.
    
    Specified by:
    
    parse in interface XmlParserInterface
    
    Parameters:
    
    ifsxmlparser - this object is the entry point parser and can be used by the content-specific parsers to construct the DOM object, using the Oracle DOM parser
    
    stream - the InputStream
    
    callback - an application object that interacts with the the parsing process; optional, can be null
    
    options - any parser-specific options
    
    Returns:
    
    The primary object created. If there is only one top level object then this is returned. If no object is "primary" then null is returned.
    
    Throws:
    
    IfsException - (IFS-12601) if the operation fails
    
    (Unpublished)
  - parse
```
public LibraryObject parse(IfsXmlParser ifsxmlparser,
                           Reader reader,
                           ParserCallback callback,
                           Hashtable options)
                    throws IfsException
```
    Description copied from interface: XmlParserInterface
    
    Parses the specified Reader representing an XML document.
    
    Specified by:
    
    parse in interface XmlParserInterface
    
    Parameters:
    
    ifsxmlparser - this object is the entry point parser and is used by the content-specific parsers to construct the DOM object, using the Oracle DOM parser
    
    reader - the Reader
    
    callback - an application object that interacts with the the parsing process; optional, can be null
    
    options - any parser-specific options
    
    Returns:
    
    The primary object created. If there is only one top level object then this is returned. If no object is "primary" then null is returned.
    
    Throws:
    
    IfsException - (IFS-12602) if the operation fails
    
    (Unpublished)
  - traverseTree
```
protected LibraryObject traverseTree(Document doc,
                                     ParserCallback callback,
                                     Hashtable options)
                              throws IfsException
```
    Traverses the DOM tree and creates the appropriate LibraryObjects.
    For each LibraryObject created, the implementation must call the appropriate callback methods (if any).
    The creation of LOs is transactional. That is either all LOs will be created or none will. There is an exception to this rule. Creating certain LOs casues a database commit. When this occurs a transaction can no longer be aborted. What this means for traverseTree is once one of these objects is created then all the objects created before that object in the transaction will also be committed. Now, if later in the transaction creating an object fails, the transaction can't be aborted. Forcing the transaction to be commited. Meaning all objects up to the failure will exist. The XML source may no longer be valid considering at least one object in the source already exists. LibraryObjects that cause commits currently are DirectoryUser and ClassObject. The javadoc should be consulted for up-to-date information about a particular LO.
    
    Parameters:
    
    doc - the XMLDocument (DOM tree created from the Parser's InputStream/Reader) to traverse
    
    callback - an application object that interacts with the parsing process; optional, can be null
    
    options - the Hashtable containing any Parser-specific options for this parser
    
    Returns:
    
    The primary object created. If there is only one top level object then this is returned. If no object is "primary" then null is returned.
    
    Throws:
    
    IfsException - if the operation fails
    
    (Unpublished)
  - getImplementation
```
protected SimpleXmlParserImpl getImplementation(ParserCallback callback,
                                                Hashtable options)
                                         throws IfsException
```
    Creates a SimpleXmlParserImpl to parse the document with.
    
    Throws:
    
    IfsException
    
    (Unpublished)

Class IfsSimpleXmlParser

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

IGNORE_UNSETTABLE_OPTION

SIMPLE_USER_TAG

OBJECT_LIST_TAG

ARRAY_ELEMENT_TAG

CATEGORIES_TAG

FOLDER_PATH_TAG

UPDATE_TAG

OPTIONS_TAG

POLICIES_TAG

POLICY_TAG

MEMBERS_TAG

PROPERTIES_TAG

DATATYPE_TAG

DOMAINTYPE_ATTRIBUTE

PROPERTY_VALUE_TAG

CONTENT_TAG

MEDIA_TAG

FORMAT_TAG

ATTRIBUTES_TAG

ACES_TAG

ACCESS_LEVEL_TAG

GRANTEE_TAG

PERMISSIONBUNDLES_TAG

PASSWORD_TAG

ACTION_ATTRIBUTE

FORMAT_ATTRIBUTE

DATATYPE_ATTRIBUTE

DEFINITION_ATTRIBUTE

CLASSNAME_ATTRIBUTE

REFERENCE_TYPE_ATTRIBUTE

REFERENCE_BY_PATH

REFERENCE_BY_ID

REFERENCE_BY_NAME

REFERENCE_BY_VALUEDEFAULT

VALUEDEFAULT_VALUE_TAG

VALUEDOMAIN_VALUE_TAG

REFERENCE_BY_EXISTING

REMOVE_ACTION

ADD_ACTION

m_Session

m_Parser

m_InputStream

m_Reader

m_CharacterEncoding

Constructor Detail

IfsSimpleXmlParser

Method Detail

handleUnknownTag

parse

parse

traverseTree

getImplementation