synchronized.
Early tests suggest that doing so is not causing a significant
performance hit in Xalan. However, it should be noted that there
is a possible alternative solution: rewrite release() so it merely
posts a request for release onto a threadsafe queue, and explicitly
process that queue on an infrequent basis during main-thread
activity (eg, when getDTM() is invoked). The downside of that solution
would be a greater delay before the DTM's storage is actually released
for reuse.
| Modifier and Type | Field and Description |
|---|---|
| private static final boolean | DEBUG
Set this to true if you want a basic diagnostics. |
| private static final boolean | DUMPTREE
Set this to true if you want a dump of the DTM after creation. |
| protected DefaultHandler | m_defaultHandler
The default implementation of ContentHandler, DTDHandler and ErrorHandler. |
| pack-priv int[] | m_dtm_offsets
Map from DTM identifier numbers to offsets. |
| protected DTM[] | m_dtms
Map from DTM identifier numbers to DTM objects that this manager manages. |
| private ExpandedNameTable | m_expandedNameTable
The default table for exandedNameID lookups. |
| protected XMLReaderManager | m_readerManager
The cache for XMLReader objects to be used if the user did not supply an XMLReader for a SAXSource or supplied a StreamSource. |
| Access | Constructor and Description |
|---|---|
| public |
| Modifier and Type | Method and Description | ||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| public synchronized void | |||||||||||||||||||||||||||||
| public synchronized void | addDTM(DTM Should be a valid reference to a DTM. dtm, int Integer DTM ID to be bound to this DTM. id, int Integer addressing offset. The internal DTM Node ID is
obtained by adding this offset to the node-number field of the
public DTM Handle. For the first DTM ID accessing each DTM, this is 0;
for overflow addressing it will be a multiple of 1<
Add a DTM to the DTM table. public synchronized DTM | createDocumentFragment()
Implements abstract com. Method createDocumentFragment NEEDSDOC (createDocumentFragment) @return public synchronized DTMIterator | createDTMIterator(int
This flag specifies which node types may appear in
the logical view of the tree presented by the iterator. See the
description of whatToShow, DTMFilter NodeFilter for the set of possible
SHOW_ values.These flags can be combined using
OR.The filter, boolean NodeFilter to be used with this
DTMFilter, or null to indicate no filter.The value of this flag determines
whether entity reference nodes are expanded. entityReferenceExpansion)Implements abstract com. NEEDSDOC Method createDTMIterator NEEDSDOC @param whatToShow NEEDSDOC @param filter NEEDSDOC @param entityReferenceExpansion NEEDSDOC (createDTMIterator) @return public synchronized DTMIterator | createDTMIterator(String
Must be a valid string expressing a
LocationPath or
a UnionExpr. xpathString, PrefixResolver An object that can resolve prefixes to namespace URLs. presolver)Implements abstract com. NEEDSDOC Method createDTMIterator NEEDSDOC @param xpathString NEEDSDOC @param presolver NEEDSDOC (createDTMIterator) @return public synchronized DTMIterator | createDTMIterator(int
The node handle that the DTMIterator will iterate to. node)Implements abstract com. NEEDSDOC Method createDTMIterator NEEDSDOC @param node NEEDSDOC (createDTMIterator) @return public synchronized DTMIterator | createDTMIterator(Object
??? 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. xpathCompiler, int The position in the expression. pos)Implements abstract com. NEEDSDOC Method createDTMIterator NEEDSDOC @param xpathCompiler NEEDSDOC @param pos NEEDSDOC (createDTMIterator) @return public synchronized DTM | Returns: a non-null DTM reference.the specification of the source object. source, boolean true if the returned DTM must be unique, probably because it
is going to be mutated. unique, DTMWSFilter Enables filtering of whitespace nodes, and may
be null. whiteSpaceFilter, boolean true if the DTM should be built incrementally, if
possible. incremental, boolean true if the caller considers it worth it to use
indexing schemes. doIndexing)Implements abstract com. Get an instance of a DTM, loaded with the content from the specified source. public synchronized DTM | Returns: a reference to the DTM object containing this node.DTM Handle indicating which node to retrieve nodeHandle)Implements abstract com. Return the DTM object containing a representation of this node. public synchronized int | Returns: a valid DTM handle.Non-null reference to a DOM node. node)Implements abstract com. Given a W3C DOM node, try and return a DTM handle. public synchronized int | Returns: The DTM ID (as the high bits of a NodeHandle, not as our internal index), or -1 if the DTM doesn't belong to this manager.The DTM which (hopefully) contains this node. dtm)Implements abstract com. Given a DTM, find the ID number in the DTM tables which addresses the start of the document. public ExpandedNameTable |
| public synchronized int |
| public synchronized XMLReader | Returns: a SAX2 XMLReader to use to resolve the inputSource argument. non-null XMLReader reference ready to parse.The value returned from the URIResolver. inputSource)This method returns the SAX2 parser to use with the InputSource obtained from this URI. public synchronized boolean | Returns: true if the DTM was released, false if shouldHardDelete was set and we decided not to.the DTM to be released. dtm, boolean If false, this call is a suggestion rather than an
order, and we may not actually release the DTM. This is intended to
support intelligent caching of documents... which is not implemented
in this version of the DTM manager. shouldHardDelete)Implements abstract com. Release the DTMManager's reference(s) to a DTM, making it unmanaged. public synchronized void | releaseXMLReader(XMLReader
The XMLReader to be released. reader)Indicates that the XMLReader object is no longer in use for the transform. |
| DEBUG | back to summary |
|---|---|
| private static final boolean DEBUG Set this to true if you want a basic diagnostics. | |
| DUMPTREE | back to summary |
|---|---|
| private static final boolean DUMPTREE Set this to true if you want a dump of the DTM after creation. | |
| m_defaultHandler | back to summary |
|---|---|
| protected DefaultHandler m_defaultHandler The default implementation of ContentHandler, DTDHandler and ErrorHandler. | |
| m_dtm_offsets | back to summary |
|---|---|
| pack-priv int[] m_dtm_offsets Map from DTM identifier numbers to offsets. For small DTMs with a single identifier, this will always be 0. In overflow addressing, where additional identifiers are allocated to access nodes beyond the range of a single Node Handle, this table is used to map the handle's node field into the actual node identifier. This array grows as necessary; see addDTM(). This array grows as necessary; see addDTM(). Growth is uncommon... but access needs to be blindingly fast since it's used in node addressing. (And at the moment, that includes accessing it from DTMDefaultBase, which is why this is not Protected or Private.) | |
| m_dtms | back to summary |
|---|---|
| protected DTM[] m_dtms Map from DTM identifier numbers to DTM objects that this manager manages. One DTM may have several prefix numbers, if extended node indexing is in use; in that case, m_dtm_offsets[] will used to control which prefix maps to which section of the DTM. This array grows as necessary; see addDTM(). This array grows as necessary; see addDTM(). Growth is uncommon... but access needs to be blindingly fast since it's used in node addressing. | |
| m_expandedNameTable | back to summary |
|---|---|
| private ExpandedNameTable m_expandedNameTable The default table for exandedNameID lookups. | |
| m_readerManager | back to summary |
|---|---|
| protected XMLReaderManager m_readerManager The cache for XMLReader objects to be used if the user did not supply an XMLReader for a SAXSource or supplied a StreamSource. | |
| DTMManagerDefault | back to summary |
|---|---|
| public DTMManagerDefault() Constructor DTMManagerDefault | |
| addDTM | back to summary |
|---|---|
| public synchronized void addDTM(DTM dtm, int id) Add a DTM to the DTM table. This convenience call adds it as the "base DTM ID", with offset 0. The other version of addDTM should be used if you want to add "extended" DTM IDs with nonzero offsets.
| |
| addDTM | back to summary |
|---|---|
| public synchronized void addDTM(DTM dtm, int id, int offset) Add a DTM to the DTM table.
| |
| createDocumentFragment | back to summary |
|---|---|
| public synchronized DTM createDocumentFragment() Implements abstract com. Method createDocumentFragment NEEDSDOC (createDocumentFragment) @return
| |
| createDTMIterator | back to summary |
|---|---|
| public synchronized DTMIterator createDTMIterator(int whatToShow, DTMFilter filter, boolean entityReferenceExpansion) Implements abstract com. NEEDSDOC Method createDTMIterator NEEDSDOC @param whatToShow NEEDSDOC @param filter NEEDSDOC @param entityReferenceExpansion NEEDSDOC (createDTMIterator) @return
| |
| createDTMIterator | back to summary |
|---|---|
| public synchronized DTMIterator createDTMIterator(String xpathString, PrefixResolver presolver) Implements abstract com. NEEDSDOC Method createDTMIterator NEEDSDOC @param xpathString NEEDSDOC @param presolver NEEDSDOC (createDTMIterator) @return
| |
| createDTMIterator | back to summary |
|---|---|
| public synchronized DTMIterator createDTMIterator(int node) Implements abstract com. NEEDSDOC Method createDTMIterator NEEDSDOC @param node NEEDSDOC (createDTMIterator) @return
| |
| createDTMIterator | back to summary |
|---|---|
| public synchronized DTMIterator createDTMIterator(Object xpathCompiler, int pos) Implements abstract com. NEEDSDOC Method createDTMIterator NEEDSDOC @param xpathCompiler NEEDSDOC @param pos NEEDSDOC (createDTMIterator) @return
| |
| getDTM | back to summary |
|---|---|
| public synchronized DTM getDTM(Source source, boolean unique, DTMWSFilter whiteSpaceFilter, boolean incremental, boolean doIndexing) Implements abstract com. 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. A bit of magic in this implementation: If the source is null, unique is true, and incremental and doIndexing are both false, we return an instance of SAX2RTFDTM, which see. (I think more parameters will need to be added for error handling, and entity resolution, and more explicit control of the RTF situation).
| |
| getDTM | back to summary |
|---|---|
| public synchronized DTM getDTM(int nodeHandle) Implements abstract com. Return the DTM object containing a representation of this node.
| |
| getDTMHandleFromNode | back to summary |
|---|---|
| public synchronized int getDTMHandleFromNode(Node node) Implements abstract com. Given a W3C DOM node, try and return a DTM handle. Note calling this may be non-optimal, and there is no guarantee that the node will be found in any particular DTM.
| |
| getDTMIdentity | back to summary |
|---|---|
| public synchronized int getDTMIdentity(DTM dtm) Implements abstract com. Given a DTM, find the ID number in the DTM tables which addresses the start of the document. If overflow addressing is in use, other DTM IDs may also be assigned to this DTM.
| |
| getExpandedNameTable | back to summary |
|---|---|
| public ExpandedNameTable getExpandedNameTable(DTM dtm) return the expanded name table. NEEDSDOC @param dtm NEEDSDOC ($objectName$) @return | |
| getFirstFreeDTMID | back to summary |
|---|---|
| public synchronized int getFirstFreeDTMID() Get the first free DTM ID available. %OPT% Linear search is inefficient! | |
| getXMLReader | back to summary |
|---|---|
| public synchronized XMLReader getXMLReader(Source inputSource) This method returns the SAX2 parser to use with the InputSource obtained from this URI. It may return null if any SAX2-conformant XML parser can be used, or if getInputSource() will also return null. The parser must be free for use (i.e., not currently in use for another parse(). After use of the parser is completed, the releaseXMLReader(XMLReader) must be called. | |
| release | back to summary |
|---|---|
| public synchronized boolean release(DTM dtm, boolean shouldHardDelete) Implements abstract com. Release the DTMManager's reference(s) to a DTM, making it unmanaged. This is typically done as part of returning the DTM to the heap after we're done with it.
| |
| releaseXMLReader | back to summary |
|---|---|
| public synchronized void releaseXMLReader(XMLReader reader) Indicates that the XMLReader object is no longer in use for the transform. Note that the getXMLReader method may return an XMLReader that was specified on the SAXSource object by the application code. Such a reader should still be passed to releaseXMLReader, but the reader manager will only re-use XMLReaders that it created.
| |