com.ibm.xtools.comparemerge.emf.delta.logic

Interface LogicResource

All Superinterfaces:

org.eclipse.emf.common.notify.Notifier, org.eclipse.emf.ecore.resource.Resource

All Known Subinterfaces:

XMLLogicResource

All Known Implementing Classes:

LogicResourceImpl, XMLLogicResourceImpl

public interface LogicResource
extends org.eclipse.emf.ecore.resource.Resource

Compare/mege implementation of Logical Resource that contains many subunits. Use LogicResource instead of normal resource if you want to merge your resource in logical unit.

Nested Class Summary

Nested classes/interfaces inherited from interface org.eclipse.emf.ecore.resource.Resource

org.eclipse.emf.ecore.resource.Resource.Diagnostic, org.eclipse.emf.ecore.resource.Resource.Factory, org.eclipse.emf.ecore.resource.Resource.Internal, org.eclipse.emf.ecore.resource.Resource.IOWrappedException

Field Summary

Fields inherited from interface org.eclipse.emf.ecore.resource.Resource

OPTION_CIPHER, OPTION_LINE_DELIMITER, OPTION_LINE_DELIMITER_UNSPECIFIED, OPTION_SAVE_ONLY_IF_CHANGED, OPTION_SAVE_ONLY_IF_CHANGED_FILE_BUFFER, OPTION_SAVE_ONLY_IF_CHANGED_MEMORY_BUFFER, OPTION_ZIP, RESOURCE__CONTENTS, RESOURCE__ERRORS, RESOURCE__IS_LOADED, RESOURCE__IS_MODIFIED, RESOURCE__IS_TRACKING_MODIFICATION, RESOURCE__RESOURCE_SET, RESOURCE__TIME_STAMP, RESOURCE__URI, RESOURCE__WARNINGS

Method Summary

Modifier and Type	Method and Description
void	addSubunit(org.eclipse.emf.ecore.resource.Resource resource) Add a subunit resource to this logical resource.
boolean	containSubunit(org.eclipse.emf.common.util.URI uri) Determine if this logical resource contains a subunit with the given uri
org.eclipse.emf.ecore.resource.Resource	createSubunit(org.eclipse.emf.common.util.URI uri) Create a subunit with the given URI
org.eclipse.emf.common.util.EList	getFullContents() Get a list of resouce level object including cross-containment reference root.
java.lang.Object	getProperty(java.lang.String prop, java.lang.Object defaultValue) Returns user's property Returns defaultValue if property is not defined
org.eclipse.emf.ecore.EObject	getRootElement() Get the root of this logical model.
org.eclipse.emf.ecore.resource.Resource	getRootResource() Get the root physical resource of this logical resource
org.eclipse.emf.ecore.resource.Resource	getSubunit(org.eclipse.emf.common.util.URI uri, boolean loadOnDemand) Get the subunit associated with the given uri.
java.util.List	getSubunits() Get all the subunits belong to this logical model
boolean	isRootElement(java.lang.Object object) Returns true if object is a root element of LogicResource NOTE: We can't use comparison getRootElement() == object because in closure mode LogicResource has mutliple roots
void	removeContentAdapter()
void	save(java.lang.String toPath) Save this logical resouce into the destination path.
void	setLoaded(boolean isLoaded) Set whether this logical resource has been loaded.
void	setProperty(java.lang.String prop, java.lang.Object value) Set user's property for resource
void	setRootElement(org.eclipse.emf.ecore.EObject object) This method should only be used with care.
void	setRootResource(org.eclipse.emf.ecore.resource.Resource resource) This method should only be used with care.

Methods inherited from interface org.eclipse.emf.ecore.resource.Resource

delete, getAllContents, getContents, getEObject, getErrors, getResourceSet, getTimeStamp, getURI, getURIFragment, getWarnings, isLoaded, isModified, isTrackingModification, load, load, save, save, setModified, setTimeStamp, setTrackingModification, setURI, unload

Methods inherited from interface org.eclipse.emf.common.notify.Notifier

eAdapters, eDeliver, eNotify, eSetDeliver

Method Detail

save

void save(java.lang.String toPath)
   throws java.io.IOException

Save this logical resouce into the destination path. The logical resource will be flattened into a single layer after the save operation.

Parameters:

toPath - destination path

Throws:

java.io.IOException

getFullContents

org.eclipse.emf.common.util.EList getFullContents()

Get a list of resouce level object including cross-containment reference root.

Returns:

list of subunits

getSubunits

java.util.List getSubunits()

Get all the subunits belong to this logical model

Returns:

list of subunits

getSubunit

org.eclipse.emf.ecore.resource.Resource getSubunit(org.eclipse.emf.common.util.URI uri,
                                                   boolean loadOnDemand)

Get the subunit associated with the given uri.

Parameters:

uri - given uri

loadOnDemand - whether to load on demand

Returns:

the subunit if found. otherwise, null.

addSubunit

void addSubunit(org.eclipse.emf.ecore.resource.Resource resource)

Add a subunit resource to this logical resource. The subunit can not be another logical resource.

Parameters:

resource - given subunit resource.

createSubunit

org.eclipse.emf.ecore.resource.Resource createSubunit(org.eclipse.emf.common.util.URI uri)

Create a subunit with the given URI

Parameters:

uri - given URI

Returns:

the created subunit.

containSubunit

boolean containSubunit(org.eclipse.emf.common.util.URI uri)

Determine if this logical resource contains a subunit with the given uri

Parameters:

uri - given uri

Returns:

true if contain a subunit with the uri. otherwise,false.

getRootResource

org.eclipse.emf.ecore.resource.Resource getRootResource()

Get the root physical resource of this logical resource

Returns:

root physical resouce if it exists

getRootElement

org.eclipse.emf.ecore.EObject getRootElement()

Get the root of this logical model.

Returns:

root of this logical model

isRootElement

boolean isRootElement(java.lang.Object object)

Returns true if object is a root element of LogicResource NOTE: We can't use comparison getRootElement() == object because in closure mode LogicResource has mutliple roots

Parameters:

object -

setRootElement

void setRootElement(org.eclipse.emf.ecore.EObject object)

This method should only be used with care. it was designed to be used in compare/merge junit framework Setting wrong root element to this logical resource can cause bad consequence.

Parameters:

object - new root of this logical model

setRootResource

void setRootResource(org.eclipse.emf.ecore.resource.Resource resource)

This method should only be used with care. It was designed to be used in compare/merge junit framework. Setting wrong root resource to this logical resoruce can cause bad consequence.

Parameters:

resource - root resource.

setLoaded

void setLoaded(boolean isLoaded)

Set whether this logical resource has been loaded.

Parameters:

isLoaded - set whether this logical resoruce has been loaded or not.

setProperty

void setProperty(java.lang.String prop,
                 java.lang.Object value)

Set user's property for resource

Parameters:

prop -

value -

getProperty

java.lang.Object getProperty(java.lang.String prop,
                             java.lang.Object defaultValue)

Returns user's property Returns defaultValue if property is not defined

removeContentAdapter

void removeContentAdapter()