File	Doc	Category	Size	Date	Package
DTMManager.java	API Doc	Java SE 5 API	13326	Fri Aug 26 14:56:00 BST 2005	com.sun.org.apache.xml.internal.dtm

DTMManager

• java.lang.Object

Fields Summary
private static final String	defaultPropName The default property name to load the manager.
private static String	defaultClassName The default class name to use as the manager.
protected XMLStringFactory	m_xsf Factory for creating XMLString objects. %TBD% Make this set by the caller.
public static boolean	m_incremental
private static boolean	debug Temp debug code - this will be removed after we test everything
public static final int	IDENT_DTM_NODE_BITS This value, set at compile time, controls how many bits of the DTM node identifier numbers are used to identify a node within a document, and thus sets the maximum number of nodes per document. The remaining bits are used to identify the DTM document which contains this node. If you change IDENT_DTM_NODE_BITS, be sure to rebuild _ALL_ the files which use it... including the IDKey testcases. (FuncGenerateKey currently uses the node identifier directly and thus is affected when this changes. The IDKEY results will still be _correct_ (presuming no other breakage), but simple equality comparison against the previous "golden" files will probably complain.)
public static final int	IDENT_NODE_DEFAULT When this bitmask is ANDed with a DTM node handle number, the result is the low bits of the node's index number within that DTM. To obtain the high bits, add the DTM ID portion's offset as assigned in the DTM Manager.
public static final int	IDENT_DTM_DEFAULT When this bitmask is ANDed with a DTM node handle number, the result is the DTM's document identity number.
public static final int	IDENT_MAX_DTMS This is the maximum number of DTMs available. The highest DTM is one less than this.

Constructors Summary
protected DTMManager() Default constructor is protected on purpose.

Methods Summary
public abstract com.sun.org.apache.xml.internal.dtm.DTMIterator	createDTMIterator(java.lang.Object xpathCompiler, int pos) Create a new DTMIterator based on an XPath UnionExpr. param xpathCompiler ??? Somehow we need to pass in a subpart of the expression. I hate to do this with strings, since the larger expression has already been parsed. param pos The position in the expression. return The newly created DTMIterator.
public abstract com.sun.org.apache.xml.internal.dtm.DTMIterator	createDTMIterator(java.lang.String xpathString, com.sun.org.apache.xml.internal.utils.PrefixResolver presolver) Create a new DTMIterator based on an XPath UnionExpr. param xpathString Must be a valid string expressing a UnionExpr. param presolver An object that can resolve prefixes to namespace URLs. return The newly created DTMIterator.
public abstract com.sun.org.apache.xml.internal.dtm.DTMIterator	createDTMIterator(int whatToShow, com.sun.org.apache.xml.internal.dtm.DTMFilter filter, boolean entityReferenceExpansion) Create a new DTMIterator based only on a whatToShow and a DTMFilter. The traversal semantics are defined as the descendant access. Note that DTMIterators may not be an exact match to DOM NodeIterators. They are initialized and used in much the same way as a NodeIterator, but their response to document mutation is not currently defined. param whatToShow This flag specifies which node types may appear in the logical view of the tree presented by the iterator. See the description of NodeFilter for the set of possible SHOW_ values.These flags can be combined using OR. param filter The NodeFilter to be used with this DTMFilter, or null to indicate no filter. param entityReferenceExpansion The value of this flag determines whether entity reference nodes are expanded. return The newly created DTMIterator.
public abstract com.sun.org.apache.xml.internal.dtm.DTMIterator	createDTMIterator(int node) Create a new DTMIterator that holds exactly one node. param node The node handle that the DTMIterator will iterate to. return The newly created DTMIterator.
public abstract com.sun.org.apache.xml.internal.dtm.DTM	createDocumentFragment() Creates a DTM representing an empty DocumentFragment object. return a non-null DTM reference.
public abstract com.sun.org.apache.xml.internal.dtm.DTM	getDTM(javax.xml.transform.Source source, boolean unique, com.sun.org.apache.xml.internal.dtm.DTMWSFilter whiteSpaceFilter, boolean incremental, boolean doIndexing) Get an instance of a DTM, loaded with the content from the specified source. If the unique flag is true, a new instance will always be returned. Otherwise it is up to the DTMManager to return a new instance or an instance that it already created and may be being used by someone else. (More parameters may eventually need to be added for error handling and entity resolution, and to better control selection of implementations.) param source the specification of the source object, which may be null, in which case it is assumed that node construction will take by some other means. param unique true if the returned DTM must be unique, probably because it is going to be mutated. param whiteSpaceFilter Enables filtering of whitespace nodes, and may be null. param incremental true if the DTM should be built incrementally, if possible. param doIndexing true if the caller considers it worth it to use indexing schemes. return a non-null DTM reference.
public abstract com.sun.org.apache.xml.internal.dtm.DTM	getDTM(int nodeHandle) Get the instance of DTM that "owns" a node handle. param nodeHandle the nodeHandle. return a non-null DTM reference.
public abstract int	getDTMHandleFromNode(org.w3c.dom.Node node) Given a W3C DOM node, try and return a DTM handle. Note: calling this may be non-optimal. param node Non-null reference to a DOM node. return a valid DTM handle.
public abstract int	getDTMIdentity(com.sun.org.apache.xml.internal.dtm.DTM dtm) %TBD% Doc NEEDSDOC @param dtm NEEDSDOC ($objectName$) @return
public int	getDTMIdentityMask() %TBD% Doc NEEDSDOC ($objectName$) @return return IDENT_DTM_DEFAULT;
public static synchronized boolean	getIncremental() Set a flag indicating whether an incremental transform is desired param incremental boolean to use to set m_incremental. return m_incremental;
public int	getNodeIdentityMask() %TBD% Doc NEEDSDOC ($objectName$) @return return IDENT_NODE_DEFAULT;
public com.sun.org.apache.xml.internal.utils.XMLStringFactory	getXMLStringFactory() Get the XMLStringFactory used for the DTMs. return a valid XMLStringFactory object, or null if it hasn't been set yet. return m_xsf;
public static com.sun.org.apache.xml.internal.dtm.DTMManager	newInstance(com.sun.org.apache.xml.internal.utils.XMLStringFactory xsf) Obtain a new instance of a DTMManager. This static method creates a new factory instance This method uses the following ordered lookup procedure to determine the DTMManager implementation class to load: Use the com.sun.org.apache.xml.internal.dtm.DTMManager system property. Use the JAVA_HOME(the parent directory where jdk is installed)/lib/xalan.properties for a property file that contains the name of the implementation class keyed on the same value as the system property defined above. Use the Services API (as detailed in the JAR specification), if available, to determine the classname. The Services API will look for a classname in the file META-INF/services/com.sun.org.apache.xml.internal.dtm.DTMManager in jars available to the runtime. Use the default DTMManager classname, which is com.sun.org.apache.xml.internal.dtm.ref.DTMManagerDefault. Once an application has obtained a reference to a DTMManager it can use the factory to configure and obtain parser instances. return new DTMManager instance, never null. throws DTMConfigurationException if the implementation is not available or cannot be instantiated. DTMManager factoryImpl = null; try { factoryImpl = (DTMManager) ObjectFactory .createObject(defaultPropName, defaultClassName); } catch (ObjectFactory.ConfigurationError e) { throw new DTMConfigurationException(XMLMessages.createXMLMessage( XMLErrorResources.ER_NO_DEFAULT_IMPL, null), e.getException()); //"No default implementation found"); } if (factoryImpl == null) { throw new DTMConfigurationException(XMLMessages.createXMLMessage( XMLErrorResources.ER_NO_DEFAULT_IMPL, null)); //"No default implementation found"); } factoryImpl.setXMLStringFactory(xsf); return factoryImpl;
public abstract boolean	release(com.sun.org.apache.xml.internal.dtm.DTM dtm, boolean shouldHardDelete) Release a DTM either to a lru pool, or completely remove reference. DTMs without system IDs are always hard deleted. State: experimental. param dtm The DTM to be released. param shouldHardDelete True if the DTM should be removed no matter what. return true if the DTM was removed, false if it was put back in a lru pool.
public static synchronized void	setIncremental(boolean incremental) Set a flag indicating whether an incremental transform is desired param incremental boolean to use to set m_incremental. m_incremental = incremental;
public void	setXMLStringFactory(com.sun.org.apache.xml.internal.utils.XMLStringFactory xsf) Set the XMLStringFactory used for the DTMs. param xsf a valid XMLStringFactory object, should not be null. m_xsf = xsf;