|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.emf.common.notify.impl.BasicNotifierImpl
org.eclipse.emf.common.notify.impl.NotifierImpl
org.eclipse.emf.ecore.resource.impl.ResourceImpl
org.eclipse.emf.ecore.xmi.impl.XMLResourceImpl
This class implements the XMLResource interface. It overloads the doLoad method to invoke the XML deserializer rather than using the default XMI loader.
Nested Class Summary |
Nested classes inherited from class org.eclipse.emf.ecore.resource.impl.ResourceImpl |
ResourceImpl.ContentsEList, ResourceImpl.ModificationTrackingAdapter |
Nested classes inherited from class org.eclipse.emf.common.notify.impl.BasicNotifierImpl |
BasicNotifierImpl.EAdapterList |
Nested classes inherited from class org.eclipse.emf.ecore.xmi.XMLResource |
XMLResource.ResourceHandler, XMLResource.XMLInfo, XMLResource.XMLMap |
Nested classes inherited from class org.eclipse.emf.ecore.resource.Resource |
Resource.Diagnostic, Resource.Factory, Resource.Internal, Resource.IOWrappedException |
Field Summary | |
protected static Map |
DETACHED_EOBJECT_TO_ID_MAP
The map from EObject to ID . |
protected DOMHandler |
domHandler
|
protected String |
encoding
|
protected Map |
eObjectToExtensionMap
|
protected Map |
eObjectToIDMap
The map from EObject to ID .
|
protected Map |
idToEObjectMap
The map from ID to EObject .
|
protected String |
publicId
|
protected String |
systemId
|
protected boolean |
useZip
|
protected String |
xmlVersion
|
Fields inherited from class org.eclipse.emf.ecore.resource.impl.ResourceImpl |
contents, defaultLoadOptions, defaultSaveOptions, errors, intrinsicIDToEObjectMap, isLoaded, isLoading, isModified, modificationTrackingAdapter, resourceSet, uri, warnings |
Fields inherited from class org.eclipse.emf.common.notify.impl.NotifierImpl |
eAdapters, EDELIVER, eFlags, ELAST_NOTIFIER_FLAG |
Fields inherited from interface org.eclipse.emf.ecore.resource.Resource |
OPTION_CIPHER, OPTION_ZIP, RESOURCE__CONTENTS, RESOURCE__ERRORS, RESOURCE__IS_LOADED, RESOURCE__IS_MODIFIED, RESOURCE__IS_TRACKING_MODIFICATION, RESOURCE__RESOURCE_SET, RESOURCE__URI, RESOURCE__WARNINGS |
Constructor Summary | |
XMLResourceImpl()
Constructor for XMLResourceImpl. |
|
XMLResourceImpl(URI uri)
Constructor for XMLResourceImpl. |
Method Summary | |
protected boolean |
assignIDsWhileLoading()
|
protected void |
attachedHelper(EObject eObject)
|
protected XMLHelper |
createXMLHelper()
|
protected XMLLoad |
createXMLLoad()
|
protected XMLSave |
createXMLSave()
|
protected void |
detachedHelper(EObject eObject)
|
void |
doLoad(InputSource inputSource,
Map options)
|
void |
doLoad(InputStream inputStream,
Map options)
Called to load the resource. |
void |
doLoad(Node node,
Map options)
|
void |
doSave(OutputStream outputStream,
Map options)
Called to save the resource. |
void |
doSave(Writer writer,
Map options)
|
protected void |
doUnload()
Does all the work of unloading the resource. |
Map |
getDefaultLoadOptions()
Returns the map of options that, in addition to the overriding options specified during load, are used to to control load behavior. |
Map |
getDefaultSaveOptions()
Returns the map of options that, in addition to the overriding options specified during save, are used to to control save behavior. |
DOMHelper |
getDOMHelper()
Returns the DOMHelper |
String |
getEncoding()
Get the XML encoding for this resource. |
protected EObject |
getEObjectByID(String id)
Returns the object based on the fragment as an ID. |
Map |
getEObjectToExtensionMap()
Returns the map with EObject as keys and corresponding AnyType s as the values.
|
Map |
getEObjectToIDMap()
Returns the Map of EObjects as keys and IDs as values. |
String |
getID(EObject eObject)
Returns the ID that was assigned with setID(EObject, String) ; if there is
no ID, it returns null. |
Map |
getIDToEObjectMap()
Returns the Map with IDs as keys and EObjects as values. |
String |
getPublicId()
Returns public identifier specified on the doctype. |
String |
getSystemId()
Returns system identifier specified on the doctype. |
String |
getURIFragment(EObject eObject)
Returns the URI fragment that,
when passed to getEObject will return the given object.
|
String |
getXMLVersion()
Get the XML version for this resource. |
protected void |
init()
|
protected boolean |
isAttachedDetachedHelperRequired()
|
protected boolean |
isPath(String uriFragment)
|
void |
load(InputSource inputSource,
Map options)
|
void |
load(Node node,
Map options)
Loads the resource from the DOM node, either an Element or Document, using the specified options. |
Document |
save(Document doc,
Map options,
DOMHandler handler)
Create a DOM tree representing contents of this resource. |
void |
save(Writer writer,
Map options)
Saves the resource to the writer using the specified options. |
void |
setDoctypeInfo(String publicId,
String systemId)
Sets the values of system and public identifiers on this resource. |
void |
setEncoding(String encoding)
Set the XML encoding for this resource. |
void |
setID(EObject eObject,
String id)
Sets the ID of the object. |
void |
setUseZip(boolean useZip)
Set whether the contents will be zipped. |
void |
setXMLVersion(String version)
Set the XML version for this resource |
String |
toKeyString()
Returns a string representation of the ID map. |
protected boolean |
useIDAttributes()
|
protected boolean |
useIDs()
|
protected boolean |
useUUIDs()
|
boolean |
useZip()
Returns whether the contents will be zipped. |
Methods inherited from class org.eclipse.emf.common.notify.impl.NotifierImpl |
eAdapters, eBasicAdapters, eDeliver, eSetDeliver |
Methods inherited from class org.eclipse.emf.common.notify.impl.BasicNotifierImpl |
eNotificationRequired, eNotify |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Methods inherited from interface org.eclipse.emf.ecore.resource.Resource |
getAllContents, getContents, getEObject, getErrors, getResourceSet, getURI, getWarnings, isLoaded, isModified, isTrackingModification, load, load, save, save, setModified, setTrackingModification, setURI, unload |
Methods inherited from interface org.eclipse.emf.common.notify.Notifier |
eAdapters, eDeliver, eNotify, eSetDeliver |
Field Detail |
protected Map idToEObjectMap
ID
to EObject
.
It is used to store IDs during a load or if the user
sets the ID of an object.
protected Map eObjectToIDMap
EObject
to ID
.
It is used to store IDs during a load or if the user
sets the ID of an object.
protected Map eObjectToExtensionMap
protected String encoding
protected String xmlVersion
protected boolean useZip
protected String publicId
protected String systemId
protected DOMHandler domHandler
protected static final Map DETACHED_EOBJECT_TO_ID_MAP
EObject
to ID
. It is used to store
IDs for objects that have been detached.
Constructor Detail |
public XMLResourceImpl()
public XMLResourceImpl(URI uri)
uri
- Method Detail |
protected void init()
protected boolean useIDs()
protected boolean useIDAttributes()
protected boolean useUUIDs()
protected boolean assignIDsWhileLoading()
public Map getDefaultSaveOptions()
XMLResource
getDefaultSaveOptions
in interface XMLResource
public Map getDefaultLoadOptions()
XMLResource
getDefaultLoadOptions
in interface XMLResource
protected XMLHelper createXMLHelper()
protected XMLLoad createXMLLoad()
protected XMLSave createXMLSave()
public void doLoad(InputStream inputStream, Map options) throws IOException
ResourceImpl
doLoad
in class ResourceImpl
inputStream
- the streamoptions
- the load options.
IOException
public void doSave(OutputStream outputStream, Map options) throws IOException
ResourceImpl
doSave
in class ResourceImpl
outputStream
- the streamoptions
- the save options.
IOException
public final void save(Writer writer, Map options) throws IOException
This implementation is final
;
clients should override doSave
.
save
in interface XMLResource
writer
- the writeroptions
- the save options.
IOException
doSave(Writer, Map)
public void doSave(Writer writer, Map options) throws IOException
IOException
public Document save(Document doc, Map options, DOMHandler handler)
XMLResource
save
in interface XMLResource
doc
- an empty Document
to use or null. If no document is specified, the
new Document
will be created using JAXP API.options
- the "save" optionshandler
- the DOMHandler
to record mappings or null.
If no DOMHandler is passed, the default DOMHandler will be created.
Document
. In the case the document is specified as a parameter,
the returned document is the same as the one specified, otherwise the newly created document is returned.public DOMHelper getDOMHelper()
XMLResource
DOMHelper
getDOMHelper
in interface XMLResource
public boolean useZip()
XMLResource
useZip
in interface XMLResource
useZip
in class ResourceImpl
ResourceImpl.newContentZipEntry()
,
ResourceImpl.isContentZipEntry(ZipEntry)
public void setUseZip(boolean useZip)
XMLResource
setUseZip
in interface XMLResource
public String getPublicId()
XMLResource
getPublicId
in interface XMLResource
public String getSystemId()
XMLResource
getSystemId
in interface XMLResource
public void setDoctypeInfo(String publicId, String systemId)
XMLResource
setDoctypeInfo
in interface XMLResource
publicId
- systemId
- public String getEncoding()
XMLResource
getEncoding
in interface XMLResource
public void setEncoding(String encoding)
XMLResource
setEncoding
in interface XMLResource
public String getXMLVersion()
XMLResource
getXMLVersion
in interface XMLResource
public void setXMLVersion(String version)
XMLResource
setXMLVersion
in interface XMLResource
public Map getIDToEObjectMap()
XMLResource
getIDToEObjectMap
in interface XMLResource
public Map getEObjectToIDMap()
XMLResource
getEObjectToIDMap
in interface XMLResource
public Map getEObjectToExtensionMap()
XMLResource
EObject
as keys and corresponding AnyType
s as the values.
It's used to record unrecognized elements and attributes.
getEObjectToExtensionMap
in interface XMLResource
public String getID(EObject eObject)
XMLResource
XMLResource.setID(EObject, String)
; if there is
no ID, it returns null.
getID
in interface XMLResource
public void setID(EObject eObject, String id)
eObjectToIDMap
.
Clients may override it to set the ID as an actual attribute object the object.
setID
in interface XMLResource
eObject
- the object.id
- the object's ID.public String getURIFragment(EObject eObject)
Resource
fragment
that,
when passed to getEObject
will return the given object.
In other words,
the following is true
for any object contained by a resource:
Resource resource = eObject.eResource(); eObject == resource.getEObject(resource.getURIFragment(eObject))An implementation may choose to use IDs or to use structured URI fragments, as supported by
eURIFragmentSegment
.
getURIFragment
in interface Resource
getURIFragment
in class ResourceImpl
protected EObject getEObjectByID(String id)
ResourceImpl
getEObjectByID
in class ResourceImpl
protected boolean isPath(String uriFragment)
protected boolean isAttachedDetachedHelperRequired()
isAttachedDetachedHelperRequired
in class ResourceImpl
protected void attachedHelper(EObject eObject)
attachedHelper
in class ResourceImpl
protected void detachedHelper(EObject eObject)
detachedHelper
in class ResourceImpl
protected void doUnload()
idToEObjectMap
and eObjectToIDMap
as necessary.
doUnload
in class ResourceImpl
public String toKeyString()
ID
map.
toKeyString
in class ResourceImpl
public final void load(Node node, Map options) throws IOException
XMLResource
This method assumes that no namespace fixup needs to be done. To process comments and CDATA section nodes, please set XMLResource.OPTION_USE_LEXICAL_HANDLER option to Boolean.TRUE.
load
in interface XMLResource
node
- DOM Element or Document node.options
- the load options.
IOException
XMLResource.save(Document, Map, DOMHandler)
public void doLoad(Node node, Map options) throws IOException
IOException
public final void load(InputSource inputSource, Map options) throws IOException
load
in interface XMLResource
IOException
public void doLoad(InputSource inputSource, Map options) throws IOException
IOException
|
Copyright 2001-2006 IBM Corporation and others. All Rights Reserved. |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |