Collaboration API Documentation

com.filenet.bso.api.util
Class BsoDataModelFactory

java.lang.Object
  |
  +--com.filenet.bso.api.util.BsoDataModelFactory

public class BsoDataModelFactory
extends java.lang.Object

The BsoDataModelFactory class creates BsoDataModel objects. This class is also responsible for generating a BsoDataModel object tree structure that represents XML content.

The createDataModelXML method accepts XML content and a BsoDataModelSaxHandler object, which parses the XML content into a tree of BsoDataModel objects.

See Also:
BsoDataModel, BsoDataModelSaxHandler

Method Summary
static BsoDataModel createDataModel(java.lang.String modelName, java.util.Map values)
          Creates a BsoDataModel object.
static BsoDataModel createDataModelXML(java.lang.String modelName, org.xml.sax.InputSource xmlInputSource, BsoDataModelSaxHandler saxHandler)
          Generates a tree structure of BsoDataModel objects that is the object-based representation the XML data.
static BsoDataModel createDataModelXML(java.lang.String modelName, java.io.InputStream xmlStream, BsoDataModelSaxHandler saxHandler)
          Generates a tree structure of BsoDataModel objects that is the object-based representation the XML input stream.
static BsoDataModel createDataModelXML(java.lang.String modelName, java.lang.String xmlContent, BsoDataModelSaxHandler saxHandler)
          Generates a tree structure of BsoDataModel objects that is the object-based representation the XML data.
static BsoWriteableDataModel createWriteableDataModel(java.lang.String modelName, java.util.Map values)
          Creates a BsoWriteableDataModel object.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

createDataModelXML

public static BsoDataModel createDataModelXML(java.lang.String modelName,
                                              java.io.InputStream xmlStream,
                                              BsoDataModelSaxHandler saxHandler)
                                       throws java.lang.Exception
Generates a tree structure of BsoDataModel objects that is the object-based representation the XML input stream.

The XML content (carried in the InputStream object) is parsed by the BsoDataModelSaxHandler object, which generates the tree structure.

For the modelName parameter, you can specify a simple name assigned to the top-level node of the tree structure or a fully-qualified Java class name, which will be used to create the top-level node.

Parameters:
modelName - A String containing a simple data model name or a full class name path.

xmlStream - The XML input stream.

saxHandler - Specialized SAX handler to parse XML content and generate the BsoDataModel tree.

Returns:
BsoDataModel tree representation of the XML input stream.

Throws:
java.lang.Exception - Thrown if the tree structure cannot be generated.

createDataModelXML

public static BsoDataModel createDataModelXML(java.lang.String modelName,
                                              java.lang.String xmlContent,
                                              BsoDataModelSaxHandler saxHandler)
                                       throws java.lang.Exception
Generates a tree structure of BsoDataModel objects that is the object-based representation the XML data.

The XML content (carried in the input String object) is parsed by the BsoDataModelSaxHandler object, which generates the tree structure.

For the modelName parameter, you can specify a simple name assigned to the top-level node of the tree structure or a fully-qualified Java class name, which will be used to create the top-level node.

Parameters:
modelName - A String containing a simple data model name or a full class name path.

xmlContent - A String containing XML data.

saxHandler - Specialized SAX handler to parse XML content and generate the BsoDataModel tree.

Returns:
BsoDataModel tree representation of the XML input stream.

createDataModelXML

public static BsoDataModel createDataModelXML(java.lang.String modelName,
                                              org.xml.sax.InputSource xmlInputSource,
                                              BsoDataModelSaxHandler saxHandler)
                                       throws java.lang.Exception
Generates a tree structure of BsoDataModel objects that is the object-based representation the XML data.

The XML content (carried in the input InputSource object) is parsed by the BsoDataModelSaxHandler object, which generates the tree structure.

For the modelName parameter, you can specify a simple name assigned to the top-level node of the tree structure or a fully-qualified Java class name, which will be used to create the top-level node.

Parameters:
modelName - A String containing a simple data model name or a full class name path.

xmlInputSource - An InputSource containing the source to parse.

saxHandler - Specialized SAX handler to parse XML content and generate the BsoDataModel tree.

Returns:
BsoDataModel tree representation of the XML input stream.

createDataModel

public static BsoDataModel createDataModel(java.lang.String modelName,
                                           java.util.Map values)
Creates a BsoDataModel object.

For the modelName parameter, you can specify a simple name that will be assigned to the object or a fully qualified Java class name, which will be used to create a specific object derived from BsoDataModel.

Parameters:
modelName - A String containing a simple data model name or a full class name path.

values - A Java Map object containing attribute/value pairs.

Returns:
A BsoDataModel object.

createWriteableDataModel

public static BsoWriteableDataModel createWriteableDataModel(java.lang.String modelName,
                                                             java.util.Map values)
Creates a BsoWriteableDataModel object.

For the modelName parameter, you can specify a simple name that will be assigned to the object or a fully-qualified Java class name, which will be used to create a specific object derived from BsoWriteableDataModel.

Parameters:
modelName - A String containing a simple data model name or a full class name path.

values - A Java Map object containing attribute/value pairs.

Returns:
A BsoWriteableDataModel object.

Collaboration API Documentation

Copyright © 2002 - 2004 FileNet Corporation. All rights reserved.