Java Doc for EntityReferenceImpl.java in  » XML » xerces-2_9_1 » org » apache » xerces » dom » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » XML » xerces 2_9_1 » org.apache.xerces.dom 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   org.apache.xerces.dom.NodeImpl
      org.apache.xerces.dom.ChildNode
         org.apache.xerces.dom.ParentNode
            org.apache.xerces.dom.EntityReferenceImpl

All known Subclasses:   org.apache.xerces.dom.DeferredEntityReferenceImpl,
EntityReferenceImpl
public class EntityReferenceImpl extends ParentNode implements EntityReference(Code)
EntityReference models the XML &entityname; syntax, when used for entities defined by the DOM. Entities hardcoded into XML, such as character entities, should instead have been translated into text by the code which generated the DOM tree.

An XML processor has the alternative of fully expanding Entities into the normal document tree. If it does so, no EntityReference nodes will appear.

Similarly, non-validating XML processors are not required to read or process entity declarations made in the external subset or declared in external parameter entities. Hence, some applications may not make the replacement value available for Parsed Entities of these types.

EntityReference behaves as a read-only node, and the children of the EntityReference (which reflect those of the Entity, and should also be read-only) give its replacement value, if any. They are supposed to automagically stay in synch if the DocumentType is updated with new values for the Entity.

The defined behavior makes efficient storage difficult for the DOM implementor. We can't just look aside to the Entity's definition in the DocumentType since those nodes have the wrong parent (unless we can come up with a clever "imaginary parent" mechanism). We must at least appear to clone those children... which raises the issue of keeping the reference synchronized with its parent. This leads me back to the "cached image of centrally defined data" solution, much as I dislike it.

For now I have decided, since REC-DOM-Level-1-19980818 doesn't cover this in much detail, that synchronization doesn't have to be considered while the user is deep in the tree. That is, if you're looking within one of the EntityReferennce's children and the Entity changes, you won't be informed; instead, you will continue to access the same object -- which may or may not still be part of the tree. This is the same behavior that obtains elsewhere in the DOM if the subtree you're looking at is deleted from its parent, so it's acceptable here. (If it really bothers folks, we could set things up so deleted subtrees are walked and marked invalid, but that's not part of the DOM's defined behavior.)

As a result, only the EntityReference itself has to be aware of changes in the Entity. And it can take advantage of the same structure-change-monitoring code I implemented to support DeepNodeList.
author:
   Arnaud Le Hors, IBM
author:
   Joe Kesselman, IBM
author:
   Andy Clark, IBM
author:
   Ralf Pfeiffer, IBM
version:
   $Id: EntityReferenceImpl.java 447266 2006-09-18 05:57:49Z mrglavas $
since:
   PR-DOM-Level-1-19980818.



Field Summary
protected  StringbaseURI
    
protected  Stringname
    
final static  longserialVersionUID
     Serialization version.

Constructor Summary
public  EntityReferenceImpl(CoreDocumentImpl ownerDoc, String name)
     Factory constructor.

Method Summary
public  NodecloneNode(boolean deep)
     Clone node.
public  StringgetBaseURI()
     Returns the absolute base URI of this node or null if the implementation wasn't able to obtain an absolute URI.
protected  StringgetEntityRefValue()
     NON-DOM: compute string representation of the entity reference. This method is used to retrieve a string value for an attribute node that has child nodes.
public  StringgetNodeName()
    
public  shortgetNodeType()
     A short integer indicating what type of node this is.
public  voidsetBaseURI(String uri)
    
public  voidsetReadOnly(boolean readOnly, boolean deep)
     NON-DOM: sets the node and its children value.
protected  voidsynchronizeChildren()
     EntityReference's children are a reflection of those defined in the named Entity.

Field Detail
baseURI
protected String baseURI(Code)
Base URI



name
protected String name(Code)
Name of Entity referenced



serialVersionUID
final static long serialVersionUID(Code)
Serialization version.




Constructor Detail
EntityReferenceImpl
public EntityReferenceImpl(CoreDocumentImpl ownerDoc, String name)(Code)
Factory constructor.




Method Detail
cloneNode
public Node cloneNode(boolean deep)(Code)
Clone node.



getBaseURI
public String getBaseURI()(Code)
Returns the absolute base URI of this node or null if the implementation wasn't able to obtain an absolute URI. Note: If the URI is malformed, a null is returned. The absolute base URI of this node or null.
since:
   DOM Level 3



getEntityRefValue
protected String getEntityRefValue()(Code)
NON-DOM: compute string representation of the entity reference. This method is used to retrieve a string value for an attribute node that has child nodes. String representing a value of this entity ref. or null if any node other than EntityReference, Text is encounteredduring computation



getNodeName
public String getNodeName()(Code)
Returns the name of the entity referenced



getNodeType
public short getNodeType()(Code)
A short integer indicating what type of node this is. The named constants for this value are defined in the org.w3c.dom.Node interface.



setBaseURI
public void setBaseURI(String uri)(Code)
NON-DOM: set base uri



setReadOnly
public void setReadOnly(boolean readOnly, boolean deep)(Code)
NON-DOM: sets the node and its children value.

Note: make sure that entity reference and its kids could be set readonly.




synchronizeChildren
protected void synchronizeChildren()(Code)
EntityReference's children are a reflection of those defined in the named Entity. This method creates them if they haven't been created yet. This doesn't support editing the Entity though, since this only called once for all.



Fields inherited from org.apache.xerces.dom.ParentNode
protected transient NodeListCache fNodeListCache(Code)(Java Doc)
protected ChildNode firstChild(Code)(Java Doc)
protected CoreDocumentImpl ownerDocument(Code)(Java Doc)
final static long serialVersionUID(Code)(Java Doc)

Methods inherited from org.apache.xerces.dom.ParentNode
void checkNormalizationAfterInsert(ChildNode insertedChild)(Code)(Java Doc)
void checkNormalizationAfterRemove(ChildNode previousSibling)(Code)(Java Doc)
public Node cloneNode(boolean deep)(Code)(Java Doc)
public NodeList getChildNodes()(Code)(Java Doc)
final protected NodeList getChildNodesUnoptimized()(Code)(Java Doc)
public Node getFirstChild()(Code)(Java Doc)
public Node getLastChild()(Code)(Java Doc)
public int getLength()(Code)(Java Doc)
public Document getOwnerDocument()(Code)(Java Doc)
public String getTextContent() throws DOMException(Code)(Java Doc)
void getTextContent(StringBuffer buf) throws DOMException(Code)(Java Doc)
public boolean hasChildNodes()(Code)(Java Doc)
final boolean hasTextContent(Node child)(Code)(Java Doc)
public Node insertBefore(Node newChild, Node refChild) throws DOMException(Code)(Java Doc)
Node internalInsertBefore(Node newChild, Node refChild, boolean replace) throws DOMException(Code)(Java Doc)
Node internalRemoveChild(Node oldChild, boolean replace) throws DOMException(Code)(Java Doc)
public boolean isEqualNode(Node arg)(Code)(Java Doc)
public Node item(int index)(Code)(Java Doc)
final ChildNode lastChild()(Code)(Java Doc)
final void lastChild(ChildNode node)(Code)(Java Doc)
public void normalize()(Code)(Java Doc)
CoreDocumentImpl ownerDocument()(Code)(Java Doc)
public Node removeChild(Node oldChild) throws DOMException(Code)(Java Doc)
public Node replaceChild(Node newChild, Node oldChild) throws DOMException(Code)(Java Doc)
protected void setOwnerDocument(CoreDocumentImpl doc)(Code)(Java Doc)
public void setReadOnly(boolean readOnly, boolean deep)(Code)(Java Doc)
public void setTextContent(String textContent) throws DOMException(Code)(Java Doc)
protected void synchronizeChildren()(Code)(Java Doc)

Fields inherited from org.apache.xerces.dom.ChildNode
protected ChildNode nextSibling(Code)(Java Doc)
protected ChildNode previousSibling(Code)(Java Doc)
final static long serialVersionUID(Code)(Java Doc)

Methods inherited from org.apache.xerces.dom.ChildNode
public Node cloneNode(boolean deep)(Code)(Java Doc)
public Node getNextSibling()(Code)(Java Doc)
public Node getParentNode()(Code)(Java Doc)
public Node getPreviousSibling()(Code)(Java Doc)
final NodeImpl parentNode()(Code)(Java Doc)
final ChildNode previousSibling()(Code)(Java Doc)

Fields inherited from org.apache.xerces.dom.NodeImpl
final public static short DOCUMENT_POSITION_CONTAINS(Code)(Java Doc)
final public static short DOCUMENT_POSITION_DISCONNECTED(Code)(Java Doc)
final public static short DOCUMENT_POSITION_FOLLOWING(Code)(Java Doc)
final public static short DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC(Code)(Java Doc)
final public static short DOCUMENT_POSITION_IS_CONTAINED(Code)(Java Doc)
final public static short DOCUMENT_POSITION_PRECEDING(Code)(Java Doc)
final public static short ELEMENT_DEFINITION_NODE(Code)(Java Doc)
final protected static short FIRSTCHILD(Code)(Java Doc)
final protected static short HASSTRING(Code)(Java Doc)
final protected static short ID(Code)(Java Doc)
final protected static short IGNORABLEWS(Code)(Java Doc)
final protected static short NORMALIZED(Code)(Java Doc)
final protected static short OWNED(Code)(Java Doc)
final protected static short READONLY(Code)(Java Doc)
final protected static short SPECIFIED(Code)(Java Doc)
final protected static short SYNCCHILDREN(Code)(Java Doc)
final protected static short SYNCDATA(Code)(Java Doc)
final public static short TREE_POSITION_ANCESTOR(Code)(Java Doc)
final public static short TREE_POSITION_DESCENDANT(Code)(Java Doc)
final public static short TREE_POSITION_DISCONNECTED(Code)(Java Doc)
final public static short TREE_POSITION_EQUIVALENT(Code)(Java Doc)
final public static short TREE_POSITION_FOLLOWING(Code)(Java Doc)
final public static short TREE_POSITION_PRECEDING(Code)(Java Doc)
final public static short TREE_POSITION_SAME_NODE(Code)(Java Doc)
protected short flags(Code)(Java Doc)
protected NodeImpl ownerNode(Code)(Java Doc)
final static long serialVersionUID(Code)(Java Doc)

Methods inherited from org.apache.xerces.dom.NodeImpl
public void addEventListener(String type, EventListener listener, boolean useCapture)(Code)(Java Doc)
public Node appendChild(Node newChild) throws DOMException(Code)(Java Doc)
protected void changed()(Code)(Java Doc)
protected int changes()(Code)(Java Doc)
public Node cloneNode(boolean deep)(Code)(Java Doc)
public short compareDocumentPosition(Node other) throws DOMException(Code)(Java Doc)
public short compareTreePosition(Node other)(Code)(Java Doc)
public boolean dispatchEvent(Event event)(Code)(Java Doc)
public NamedNodeMap getAttributes()(Code)(Java Doc)
public String getBaseURI()(Code)(Java Doc)
public NodeList getChildNodes()(Code)(Java Doc)
protected Node getContainer()(Code)(Java Doc)
Node getElementAncestor(Node currentNode)(Code)(Java Doc)
public Object getFeature(String feature, String version)(Code)(Java Doc)
public Node getFirstChild()(Code)(Java Doc)
public Node getLastChild()(Code)(Java Doc)
public int getLength()(Code)(Java Doc)
public String getLocalName()(Code)(Java Doc)
public String getNamespaceURI()(Code)(Java Doc)
public Node getNextSibling()(Code)(Java Doc)
abstract public String getNodeName()(Code)(Java Doc)
protected int getNodeNumber()(Code)(Java Doc)
abstract public short getNodeType()(Code)(Java Doc)
public String getNodeValue() throws DOMException(Code)(Java Doc)
public Document getOwnerDocument()(Code)(Java Doc)
public Node getParentNode()(Code)(Java Doc)
public String getPrefix()(Code)(Java Doc)
public Node getPreviousSibling()(Code)(Java Doc)
public boolean getReadOnly()(Code)(Java Doc)
public String getTextContent() throws DOMException(Code)(Java Doc)
void getTextContent(StringBuffer buf) throws DOMException(Code)(Java Doc)
public Object getUserData(String key)(Code)(Java Doc)
public Object getUserData()(Code)(Java Doc)
protected Hashtable getUserDataRecord()(Code)(Java Doc)
public boolean hasAttributes()(Code)(Java Doc)
public boolean hasChildNodes()(Code)(Java Doc)
final boolean hasStringValue()(Code)(Java Doc)
final void hasStringValue(boolean value)(Code)(Java Doc)
public Node insertBefore(Node newChild, Node refChild) throws DOMException(Code)(Java Doc)
final boolean internalIsIgnorableWhitespace()(Code)(Java Doc)
public boolean isDefaultNamespace(String namespaceURI)(Code)(Java Doc)
public boolean isEqualNode(Node arg)(Code)(Java Doc)
final boolean isFirstChild()(Code)(Java Doc)
final void isFirstChild(boolean value)(Code)(Java Doc)
final boolean isIdAttribute()(Code)(Java Doc)
final void isIdAttribute(boolean value)(Code)(Java Doc)
final void isIgnorableWhitespace(boolean value)(Code)(Java Doc)
final boolean isNormalized()(Code)(Java Doc)
final void isNormalized(boolean value)(Code)(Java Doc)
final boolean isOwned()(Code)(Java Doc)
final void isOwned(boolean value)(Code)(Java Doc)
final boolean isReadOnly()(Code)(Java Doc)
final void isReadOnly(boolean value)(Code)(Java Doc)
public boolean isSameNode(Node other)(Code)(Java Doc)
final boolean isSpecified()(Code)(Java Doc)
final void isSpecified(boolean value)(Code)(Java Doc)
public boolean isSupported(String feature, String version)(Code)(Java Doc)
public Node item(int index)(Code)(Java Doc)
String lookupNamespacePrefix(String namespaceURI, ElementImpl el)(Code)(Java Doc)
public String lookupNamespaceURI(String specifiedPrefix)(Code)(Java Doc)
public String lookupPrefix(String namespaceURI)(Code)(Java Doc)
final boolean needsSyncChildren()(Code)(Java Doc)
final public void needsSyncChildren(boolean value)(Code)(Java Doc)
final boolean needsSyncData()(Code)(Java Doc)
final void needsSyncData(boolean value)(Code)(Java Doc)
public void normalize()(Code)(Java Doc)
CoreDocumentImpl ownerDocument()(Code)(Java Doc)
NodeImpl parentNode()(Code)(Java Doc)
ChildNode previousSibling()(Code)(Java Doc)
public Node removeChild(Node oldChild) throws DOMException(Code)(Java Doc)
public void removeEventListener(String type, EventListener listener, boolean useCapture)(Code)(Java Doc)
public Node replaceChild(Node newChild, Node oldChild) throws DOMException(Code)(Java Doc)
public void setNodeValue(String x) throws DOMException(Code)(Java Doc)
protected void setOwnerDocument(CoreDocumentImpl doc)(Code)(Java Doc)
public void setPrefix(String prefix) throws DOMException(Code)(Java Doc)
public void setReadOnly(boolean readOnly, boolean deep)(Code)(Java Doc)
public void setTextContent(String textContent) throws DOMException(Code)(Java Doc)
public Object setUserData(String key, Object data, UserDataHandler handler)(Code)(Java Doc)
public void setUserData(Object data)(Code)(Java Doc)
protected void synchronizeData()(Code)(Java Doc)
public String toString()(Code)(Java Doc)

Methods inherited from java.lang.Object
native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.