Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.eclipse.emf.mapping
Interface MappingRoot

All Superinterfaces:

EObject, Mapping, Notifier

All Known Subinterfaces:

Ecore2EcoreMappingRoot

All Known Implementing Classes:

Ecore2EcoreMappingRootImpl, MappingRootImpl

public interface MappingRoot

extends Mapping

A representation of the model object 'Root'.

The following features are supported:

• Output Read Only
• Top To Bottom
• Command Stack

See Also:

MappingPackage.getMappingRoot()

Method Summary

boolean	canCreateMapping(Collection inputs, Collection outputs, Mapping mapping) If mapping is null, this checks if a mapping can be created with the given inputs and outputs.
boolean	canRemoveMapping(Mapping mapping) This checks if the given mapping can be removed.
Mapping	createMapping(Collection inputs, Collection outputs) This creates a new, appropriately-parented, mapping object with the given collections of input and output objects.
void	deregister(Mapping mapping) This removes cached information about this mapping.
void	dispose() This disposes all the adapters used to record the mapped object state.
Collection	getAllMappings(Collection collection) This returns the intersection of the result of getMappings(Object) for each object of the collection.
String	getCommandStack() Returns the value of the 'Command Stack' attribute
MappingDomain	getDomain() This returns the associated mapping domain.
Collection	getExactMappings(Collection collection) This returns the subset of mappings returned by getAllMappings(java.util.Collection) such that have each mapping has exactly the collection as its mapped objects, i.e., as return by Mapping#getMappedObjects().
MappedObjectState	getMappedObjectState(Object object) This returns the mapping state, if any, of the given object.
Collection	getMappings(Object object) This returns a collection of the mappings that refer to the given object.
Mapping	getParentMapping(Collection collection) This returns the mapping in the tree that would be the parent of a mapping that has the given collection as its mapped objects.
MappingRoot	getTypeMappingRoot() This returns the root of the type mapping model.
boolean	isAttachedObject(Object object) This returns whether the given object descends from one of the root's input or output objects.
boolean	isBottomObject(Object object) This returns whether the given object is a bottom domain object.
boolean	isDirty() This method returns true if the mapping tree needs to be saved.
boolean	isInputObject(Object object) This returns whether the given object is an input object in the domain.
boolean	isOutputDirty() This method returns true if the mapping output needs to be saved.
boolean	isOutputObject(Object object) This returns whether the given object is an output object in the domain.
boolean	isOutputReadOnly() Returns the value of the 'Output Read Only' attribute
boolean	isTopObject(Object object) This returns whether the given object is a top domain object.
boolean	isTopToBottom() Returns the value of the 'Top To Bottom' attribute
void	refreshMappedObjectStates(Mapping subtree) This refreshes the mapped objects states of all mappings rooted at the specified mapping subtree.
void	register(Mapping mapping) This adds cached information about this mapping.
void	resetDirty() This method resets the mapping and output dirty flags.
void	setCommandStack(String value) Sets the value of the 'Command Stack' attribute
void	setDomain(MappingDomain domain) This sets the domain of this mapping root.
void	setOutputDirty(boolean dirty) This method sets the output dirty flag.
void	setOutputReadOnly(boolean value) Sets the value of the 'Output Read Only' attribute
void	setTopToBottom(boolean value) Sets the value of the 'Top To Bottom' attribute

Methods inherited from interface org.eclipse.emf.mapping.Mapping

getBottoms, getEffectiveHelper, getHelper, getInputs, getMappedObjects, getMappingRoot, getNested, getNestedIn, getOutputs, getReceivers, getSenders, getTops, getTypeMapping, isReverse, setHelper, setNestedIn, setTypeMapping, treeIterator, treeIterator

Methods inherited from interface org.eclipse.emf.ecore.EObject

eAllContents, eClass, eContainer, eContainingFeature, eContainmentFeature, eContents, eCrossReferences, eGet, eGet, eIsProxy, eIsSet, eResource, eSet, eUnset

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

eAdapters, eDeliver, eNotify, eSetDeliver

Method Detail

isOutputReadOnly

public boolean isOutputReadOnly()

Returns the value of the 'Output Read Only' attribute.

If the meaning of the 'Output Read Only' attribute isn't clear, there really should be more of a description here...

Returns:

the value of the 'Output Read Only' attribute.

See Also:

setOutputReadOnly(boolean), MappingPackage.getMappingRoot_OutputReadOnly()

setOutputReadOnly

public void setOutputReadOnly(boolean value)

Sets the value of the 'Output Read Only' attribute.

Parameters:

value - the new value of the 'Output Read Only' attribute.

See Also:

isOutputReadOnly()

isTopToBottom

public boolean isTopToBottom()

Returns the value of the 'Top To Bottom' attribute.

If the meaning of the 'Top To Bottom' attribute isn't clear, there really should be more of a description here...

Returns:

the value of the 'Top To Bottom' attribute.

See Also:

setTopToBottom(boolean), MappingPackage.getMappingRoot_TopToBottom()

setTopToBottom

public void setTopToBottom(boolean value)

Sets the value of the 'Top To Bottom' attribute.

Parameters:

value - the new value of the 'Top To Bottom' attribute.

See Also:

isTopToBottom()

getCommandStack

public String getCommandStack()

Returns the value of the 'Command Stack' attribute.

If the meaning of the 'Command Stack' attribute isn't clear, there really should be more of a description here...

Returns:

the value of the 'Command Stack' attribute.

See Also:

setCommandStack(String), MappingPackage.getMappingRoot_CommandStack()

setCommandStack

public void setCommandStack(String value)

Sets the value of the 'Command Stack' attribute.

Parameters:

value - the new value of the 'Command Stack' attribute.

See Also:

getCommandStack()

getDomain

public MappingDomain getDomain()

This returns the associated mapping domain.

setDomain

public void setDomain(MappingDomain domain)

This sets the domain of this mapping root.

refreshMappedObjectStates

public void refreshMappedObjectStates(Mapping subtree)

This refreshes the mapped objects states of all mappings rooted at the specified mapping subtree.

getMappings

public Collection getMappings(Object object)

This returns a collection of the mappings that refer to the given object.

getAllMappings

public Collection getAllMappings(Collection collection)

This returns the intersection of the result of getMappings(Object) for each object of the collection.

getExactMappings

public Collection getExactMappings(Collection collection)

This returns the subset of mappings returned by getAllMappings(java.util.Collection) such that have each mapping has exactly the collection as its mapped objects, i.e., as return by Mapping#getMappedObjects().

getParentMapping

public Mapping getParentMapping(Collection collection)

This returns the mapping in the tree that would be the parent of a mapping that has the given collection as its mapped objects.

canCreateMapping

public boolean canCreateMapping(Collection inputs,
                                Collection outputs,
                                Mapping mapping)

If mapping is null, this checks if a mapping can be created with the given inputs and outputs. If mapping is not null, it checks if the specified mapping can be changed to the given inputs and outputs.

canRemoveMapping

public boolean canRemoveMapping(Mapping mapping)

This checks if the given mapping can be removed.

createMapping

public Mapping createMapping(Collection inputs,
                             Collection outputs)

This creates a new, appropriately-parented, mapping object with the given collections of input and output objects.

resetDirty

public void resetDirty()

This method resets the mapping and output dirty flags.

isDirty

public boolean isDirty()

This method returns true if the mapping tree needs to be saved.

isOutputDirty

public boolean isOutputDirty()

This method returns true if the mapping output needs to be saved.

setOutputDirty

public void setOutputDirty(boolean dirty)

This method sets the output dirty flag.

isInputObject

public boolean isInputObject(Object object)

This returns whether the given object is an input object in the domain.

isOutputObject

public boolean isOutputObject(Object object)

This returns whether the given object is an output object in the domain.

isTopObject

public boolean isTopObject(Object object)

This returns whether the given object is a top domain object.

isBottomObject

public boolean isBottomObject(Object object)

This returns whether the given object is a bottom domain object.

isAttachedObject

public boolean isAttachedObject(Object object)

This returns whether the given object descends from one of the root's input or output objects.

register

public void register(Mapping mapping)

This adds cached information about this mapping.

deregister

public void deregister(Mapping mapping)

This removes cached information about this mapping.

getMappedObjectState

public MappedObjectState getMappedObjectState(Object object)

This returns the mapping state, if any, of the given object.

getTypeMappingRoot

public MappingRoot getTypeMappingRoot()

This returns the root of the type mapping model.

dispose

public void dispose()

This disposes all the adapters used to record the mapped object state.