Package org.dom4j
Class DocumentFactory
- java.lang.Object
 - 
- org.dom4j.DocumentFactory
 
 
- 
- All Implemented Interfaces:
 Serializable
- Direct Known Subclasses:
 BeanDocumentFactory,DatatypeDocumentFactory,DatatypeElementFactory,DOMDocumentFactory,IndexedDocumentFactory,NonLazyDocumentFactory,UserDataDocumentFactory
public class DocumentFactory extends Object implements Serializable
DocumentFactoryis a collection of factory methods to allow easy custom building of DOM4J trees. The default tree that is built uses a doubly linked tree. The tree built allows full XPath expressions from anywhere on the tree.- See Also:
 - Serialized Form
 
 
- 
- 
Field Summary
Fields Modifier and Type Field Description protected QNameCachecache 
- 
Constructor Summary
Constructors Constructor Description DocumentFactory() 
- 
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description AttributecreateAttribute(Element owner, String name, String value)AttributecreateAttribute(Element owner, QName qname, String value)CDATAcreateCDATA(String text)CommentcreateComment(String text)DocumentTypecreateDocType(String name, String publicId, String systemId)DocumentcreateDocument()DocumentcreateDocument(String encoding)DOCUMENT ME!DocumentcreateDocument(Element rootElement)ElementcreateElement(String name)ElementcreateElement(String qualifiedName, String namespaceURI)ElementcreateElement(QName qname)EntitycreateEntity(String name, String text)NamespacecreateNamespace(String prefix, String uri)PatterncreatePattern(String xpathPattern)createPatternparses the given XPath expression to create an XSLT stylePatterninstance which can then be used in an XSLT processing model.ProcessingInstructioncreateProcessingInstruction(String target, String data)ProcessingInstructioncreateProcessingInstruction(String target, Map<String,String> data)QNamecreateQName(String localName)QNamecreateQName(String qualifiedName, String uri)QNamecreateQName(String name, String prefix, String uri)QNamecreateQName(String localName, Namespace namespace)protected QNameCachecreateQNameCache()Factory method to create the QNameCache.protected static DocumentFactorycreateSingleton(String className)createSingletoncreates the singleton instance from the given class name.TextcreateText(String text)XPathcreateXPath(String xpathExpression)createXPathparses an XPath expression and creates a new XPathXPathinstance.XPathcreateXPath(String xpathExpression, org.jaxen.VariableContext variableContext)createXPathparses an XPath expression and creates a new XPathXPathinstance.NodeFiltercreateXPathFilter(String xpathFilterExpression)createXPathFilterparses a NodeFilter from the given XPath filter expression.NodeFiltercreateXPathFilter(String xpathFilterExpression, org.jaxen.VariableContext variableContext)createXPathFilterparses a NodeFilter from the given XPath filter expression.static DocumentFactorygetInstance()Access to singleton implementation of DocumentFactory which is used if no DocumentFactory is specified when building using the standard builders.List<QName>getQNames()Returns a list of all the QName instances currently used by this document factoryMap<String,String>getXPathNamespaceURIs()DOCUMENT ME!protected voidinit()protected QNameintern(QName qname)DOCUMENT ME!voidsetXPathNamespaceURIs(Map<String,String> namespaceURIs)Sets the namespace URIs to be used by XPath expressions created by this factory or by nodes associated with this factory. 
 - 
 
- 
- 
Field Detail
- 
cache
protected transient QNameCache cache
 
 - 
 
- 
Method Detail
- 
getInstance
public static DocumentFactory getInstance()
Access to singleton implementation of DocumentFactory which is used if no DocumentFactory is specified when building using the standard builders.- Returns:
 - the default singleon instance
 
 
- 
createDocument
public Document createDocument()
 
- 
createDocument
public Document createDocument(String encoding)
DOCUMENT ME!- Parameters:
 encoding- DOCUMENT ME!- Returns:
 - DOCUMENT ME!
 - Since:
 - 1.5
 
 
- 
createDocType
public DocumentType createDocType(String name, String publicId, String systemId)
 
- 
createProcessingInstruction
public ProcessingInstruction createProcessingInstruction(String target, String data)
 
- 
createProcessingInstruction
public ProcessingInstruction createProcessingInstruction(String target, Map<String,String> data)
 
- 
createXPath
public XPath createXPath(String xpathExpression) throws InvalidXPathException
createXPathparses an XPath expression and creates a new XPathXPathinstance.- Parameters:
 xpathExpression- is the XPath expression to create- Returns:
 - a new 
XPathinstance - Throws:
 InvalidXPathException- if the XPath expression is invalid
 
- 
createXPath
public XPath createXPath(String xpathExpression, org.jaxen.VariableContext variableContext)
createXPathparses an XPath expression and creates a new XPathXPathinstance.- Parameters:
 xpathExpression- is the XPath expression to createvariableContext- is the variable context to use when evaluating the XPath- Returns:
 - a new 
XPathinstance 
 
- 
createXPathFilter
public NodeFilter createXPathFilter(String xpathFilterExpression, org.jaxen.VariableContext variableContext)
createXPathFilterparses a NodeFilter from the given XPath filter expression. XPath filter expressions occur within XPath expressions such asself::node()[ filterExpression ]- Parameters:
 xpathFilterExpression- is the XPath filter expression to createvariableContext- is the variable context to use when evaluating the XPath- Returns:
 - a new 
NodeFilterinstance 
 
- 
createXPathFilter
public NodeFilter createXPathFilter(String xpathFilterExpression)
createXPathFilterparses a NodeFilter from the given XPath filter expression. XPath filter expressions occur within XPath expressions such asself::node()[ filterExpression ]- Parameters:
 xpathFilterExpression- is the XPath filter expression to create- Returns:
 - a new 
NodeFilterinstance 
 
- 
createPattern
public Pattern createPattern(String xpathPattern)
createPatternparses the given XPath expression to create an XSLT stylePatterninstance which can then be used in an XSLT processing model.- Parameters:
 xpathPattern- is the XPath pattern expression to create- Returns:
 - a new 
Patterninstance 
 
- 
getQNames
public List<QName> getQNames()
Returns a list of all the QName instances currently used by this document factory- Returns:
 - DOCUMENT ME!
 
 
- 
getXPathNamespaceURIs
public Map<String,String> getXPathNamespaceURIs()
DOCUMENT ME!- Returns:
 - the Map of namespace URIs that will be used by by XPath expressions to resolve namespace prefixes into namespace URIs. The map is keyed by namespace prefix and the value is the namespace URI. This value could well be null to indicate no namespace URIs are being mapped.
 
 
- 
setXPathNamespaceURIs
public void setXPathNamespaceURIs(Map<String,String> namespaceURIs)
Sets the namespace URIs to be used by XPath expressions created by this factory or by nodes associated with this factory. The keys are namespace prefixes and the values are namespace URIs.- Parameters:
 namespaceURIs- DOCUMENT ME!
 
- 
createSingleton
protected static DocumentFactory createSingleton(String className)
createSingletoncreates the singleton instance from the given class name.- Parameters:
 className- is the name of the DocumentFactory class to use- Returns:
 - a new singleton instance.
 
 
- 
intern
protected QName intern(QName qname)
DOCUMENT ME!- Parameters:
 qname- DOCUMENT ME!- Returns:
 - the cached QName instance if there is one or adds the given qname to the cache if not
 
 
- 
createQNameCache
protected QNameCache createQNameCache()
Factory method to create the QNameCache. This method should be overloaded if you wish to use your own derivation of QName.- Returns:
 - DOCUMENT ME!
 
 
- 
init
protected void init()
 
 - 
 
 -