Collaboration API Documentation

com.filenet.bso.api.util
Class BsoXPathDef

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

public class BsoXPathDef
extends java.lang.Object

The BsoXPathDef class provides information used by the BsoGenericSAXHandler class to generate Java classes from XML elements.

See Also:
BsoGenericSAXHandler, BsoXMLBinder, BsoXMLMarshal, BsoXMLUnmarshal, BsoXMLWriter

Field Summary
static int LIST_BASED
          Value of 2; indicates a list-based object type.
static int OBJECT_BASED
          Value of 1; indicates an object-based object type.
 
Constructor Summary
protected BsoXPathDef()
           
  BsoXPathDef(java.lang.String[] xpaths, java.lang.String classpath, int type, java.lang.String name)
           
  BsoXPathDef(java.lang.String xpath, java.lang.String classpath, int type, java.lang.String name)
           
 
Method Summary
 BsoXMLUnmarshal createObject(BsoXMLUnmarshal parent)
          Creates and returns a Java object that represents the XML element returned by the getXPath method.
 java.lang.String getName()
          Returns the name used as the key to store and retrieve this generated object from the parent.
 int getType()
          Returns the type of the generated object.
 java.lang.String getXPath()
          Returns an XPath style string that specifies an XML element.
 java.lang.String[] getXPaths()
          Returns an XPath style string array that specifies XML elements that share an implementation.
 boolean isMultiXPathsSupported()
          Returns TRUE if multiple xpaths are supported, FALSE if only a single xpath provided.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

OBJECT_BASED

public static int OBJECT_BASED
Value of 1; indicates an object-based object type. Objects of this type are single objects, not elements of a collection.

LIST_BASED

public static int LIST_BASED
Value of 2; indicates a list-based object type. Objects of this type are elements of a collection.
Constructor Detail

BsoXPathDef

protected BsoXPathDef()

BsoXPathDef

public BsoXPathDef(java.lang.String xpath,
                   java.lang.String classpath,
                   int type,
                   java.lang.String name)

BsoXPathDef

public BsoXPathDef(java.lang.String[] xpaths,
                   java.lang.String classpath,
                   int type,
                   java.lang.String name)
Method Detail

getXPath

public java.lang.String getXPath()
Returns an XPath style string that specifies an XML element.

getXPaths

public java.lang.String[] getXPaths()
Returns an XPath style string array that specifies XML elements that share an implementation.

isMultiXPathsSupported

public boolean isMultiXPathsSupported()
Returns TRUE if multiple xpaths are supported, FALSE if only a single xpath provided.

createObject

public BsoXMLUnmarshal createObject(BsoXMLUnmarshal parent)
Creates and returns a Java object that represents the XML element returned by the getXPath method.

Parameters:
parent - The parent object of this element.

Returns:
The object that represents the XML element.

getType

public int getType()
Returns the type of the generated object.

If the generated object type is LIST_BASED, objects of this class should be collected into a List. If the generated object type is OBJECT_BASED, objects of this class are single objects, not collections.

Returns:
An integer representing the generated object type.

getName

public java.lang.String getName()
Returns the name used as the key to store and retrieve this generated object from the parent.

Returns:
The key used to store and retrieve this object.

Collaboration API Documentation

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