Package org.eclipse.epsilon.emc.plainxml

Class PlainXmlModel

java.lang.Object

org.eclipse.epsilon.eol.models.Model

org.eclipse.epsilon.eol.models.CachedModel<Element>

org.eclipse.epsilon.emc.plainxml.PlainXmlModel

All Implemented Interfaces:

AutoCloseable, IOperationContributorProvider, IModel

public class PlainXmlModel
extends CachedModel<Element>
implements IOperationContributorProvider

Nested Class Summary

Nested classes/interfaces inherited from interface org.eclipse.epsilon.eol.models.IModel

IModel.AmbiguityCheckResult

Field Summary

Fields

Modifier and Type	Field	Description
protected ArrayList<Binding>	bindings
protected ArrayList<Element>	createdElements
protected static final String	DEFAULT_NEW_TAG_NAME
protected Document	document
protected static final String	ELEMENT_TYPE
protected File	file
protected String	idAttributeName
protected PlainXMLOperationContributor	operationContributor
static final String	PROPERTY_FILE
static final String	PROPERTY_URI
protected String	uri
protected String	xml

Fields inherited from class org.eclipse.epsilon.eol.models.CachedModel

allContentsCache, kindCache, PROPERTY_CACHED, PROPERTY_CONCURRENT, typeCache

Fields inherited from class org.eclipse.epsilon.eol.models.Model

aliases, ENV_PREFIX, name, PROPERTY_ALIASES, PROPERTY_NAME, PROPERTY_READONLOAD, PROPERTY_READONLY, PROPERTY_STOREONDISPOSAL, propertyGetter, propertySetter, readOnLoad, storeOnDisposal

Constructor Summary

Constructors

Constructor	Description
PlainXmlModel()

Method Summary

Modifier and Type	Method	Description
protected Collection<Element>	allContentsFromModel()
void	bind(String sourceTag, String sourceAttribute, String targetTag, String targetAttribute, boolean many)
void	collectAllElements(Node root, Collection<Element> elements)
Element	createInstance(String type, Collection<Object> parameters)
protected Element	createInstanceInModel(String type)
protected boolean	deleteElementInModel(Object instance)	Returns true iff the given instance was deleted from the model.
protected void	disposeModel()
protected Collection<Element>	getAllOfKindFromModel(String type)
protected Collection<Element>	getAllOfTypeFromModel(String type)
protected Collection<String>	getAllTypeNamesOf(Object instance)	Returns the fully qualified names of every type to which the given object conforms.
List<Binding>	getBindings()
protected Object	getCacheKeyForType(String type)	Returns an identity for the given type, which will be used by CachedModel as a key for the memoization of model elements by type.
Document	getDocument()
Object	getElementById(String id)
String	getElementId(Object instance)
Object	getEnumerationValue(String enumeration, String label)
File	getFile()
String	getIdAttributeName()
OperationContributor	getOperationContributor()
Node	getRoot()
String	getTypeNameOf(Object instance)	Returns a string representing the type of the instance object.
Object	getTypeOf(Object instance)
String	getUri()
String	getXml()
boolean	hasType(String type)
boolean	isInstantiable(String type)
boolean	isLoaded()	Convenience method for determining when a model has been loaded.
boolean	isModelElement(Object instance)	Used to test whether a Java object can be contained by this model.
void	load(StringProperties properties, IRelativePathResolver resolver)
protected void	loadModel()
boolean	owns(Object instance)	Used to test whether an object is contained in this model.
void	setElementId(Object instance, String newId)
void	setFile(File file)
void	setIdAttributeName(String idAttributeName)
void	setRoot(Node node)
void	setUri(String uri)
void	setXml(String xml)
boolean	store()
boolean	store(String location)
boolean	tagMatches(Element element, String name)

Methods inherited from class org.eclipse.epsilon.eol.models.CachedModel

addToCache, allContents, clearCache, createInstance, deleteElement, dispose, getAllOfKind, getAllOfKindOrType, getAllOfType, initCaches, isCachingEnabled, isConcurrent, load, removeFromCache, setCachingEnabled, setConcurrent, wrap

Methods inherited from class org.eclipse.epsilon.eol.models.Model

allInstances, getAliases, getFullyQualifiedTypeNameOf, getMetamodel, getName, getPropertyGetter, getPropertySetter, getTransactionSupport, isOfKind, isOfType, isPropertySet, isReadOnLoad, isStoredOnDisposal, knowsAboutProperty, load, load, setName, setReadOnLoad, setStoredOnDisposal

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.eclipse.epsilon.eol.models.IModel

checkAmbiguity, close

Field Details

idAttributeName

protected String idAttributeName

document

protected Document document

uri

protected String uri

file

protected File file

xml

protected String xml

operationContributor

protected PlainXMLOperationContributor operationContributor

createdElements

protected ArrayList<Element> createdElements

bindings

protected ArrayList<Binding> bindings

ELEMENT_TYPE

protected static final String ELEMENT_TYPE

See Also:

• Constant Field Values

DEFAULT_NEW_TAG_NAME

protected static final String DEFAULT_NEW_TAG_NAME

See Also:

• Constant Field Values

PROPERTY_FILE

public static final String PROPERTY_FILE

See Also:

• Constant Field Values

PROPERTY_URI

public static final String PROPERTY_URI

See Also:

• Constant Field Values

Constructor Details

PlainXmlModel

public PlainXmlModel()

Method Details

getRoot

public Node getRoot()

setRoot

public void setRoot(Node node)

allContentsFromModel

protected Collection<Element> allContentsFromModel()

Specified by:

allContentsFromModel in class CachedModel<Element>

getBindings

public List<Binding> getBindings()

getUri

public String getUri()

setUri

public void setUri(String uri)

getXml

public String getXml()

setXml

public void setXml(String xml)

getFile

public File getFile()

setFile

public void setFile(File file)

getDocument

public Document getDocument()

bind

public void bind(String sourceTag,
 String sourceAttribute,
 String targetTag,
 String targetAttribute,
 boolean many)

isLoaded

public boolean isLoaded()

Description copied from class: CachedModel

Convenience method for determining when a model has been loaded.

Overrides:

isLoaded in class CachedModel<Element>

Returns:

Whether the cache has been populated.

Since:

1.6

createInstanceInModel

protected Element createInstanceInModel(String type)
                                 throws EolModelElementTypeNotFoundException,
EolNotInstantiableModelElementTypeException

Specified by:

createInstanceInModel in class CachedModel<Element>

Throws:

EolModelElementTypeNotFoundException

EolNotInstantiableModelElementTypeException

createInstance

public Element createInstance(String type,
 Collection<Object> parameters)
                       throws EolModelElementTypeNotFoundException,
EolNotInstantiableModelElementTypeException

Specified by:

createInstance in interface IModel

Overrides:

createInstance in class Model

Throws:

EolModelElementTypeNotFoundException

EolNotInstantiableModelElementTypeException

deleteElementInModel

protected boolean deleteElementInModel(Object instance)
                                throws EolRuntimeException

Description copied from class: CachedModel

Returns true iff the given instance was deleted from the model.

Specified by:

deleteElementInModel in class CachedModel<Element>

Throws:

EolRuntimeException

collectAllElements

public void collectAllElements(Node root,
 Collection<Element> elements)

getAllOfKindFromModel

protected Collection<Element> getAllOfKindFromModel(String type)
                                             throws EolModelElementTypeNotFoundException

Specified by:

getAllOfKindFromModel in class CachedModel<Element>

Throws:

EolModelElementTypeNotFoundException

getAllOfTypeFromModel

protected Collection<Element> getAllOfTypeFromModel(String type)
                                             throws EolModelElementTypeNotFoundException

Specified by:

getAllOfTypeFromModel in class CachedModel<Element>

Throws:

EolModelElementTypeNotFoundException

tagMatches

public boolean tagMatches(Element element,
 String name)

disposeModel

protected void disposeModel()

Specified by:

disposeModel in class CachedModel<Element>

getElementById

public Object getElementById(String id)

Specified by:

getElementById in interface IModel

getElementId

public String getElementId(Object instance)

Specified by:

getElementId in interface IModel

setElementId

public void setElementId(Object instance,
 String newId)

Specified by:

setElementId in interface IModel

setIdAttributeName

public void setIdAttributeName(String idAttributeName)

getIdAttributeName

public String getIdAttributeName()

getEnumerationValue

public Object getEnumerationValue(String enumeration,
 String label)
                           throws EolEnumerationValueNotFoundException

Specified by:

getEnumerationValue in interface IModel

Throws:

EolEnumerationValueNotFoundException

getTypeNameOf

public String getTypeNameOf(Object instance)

Description copied from interface: IModel

Returns a string representing the type of the instance object. The value returned by this function can be passed to createInstance to instantiate another object of the same type as instance.

Specified by:

getTypeNameOf in interface IModel

Parameters:

instance - The model object whose type is to be determined.

Returns:

the name of the type of the model object, instance.

getCacheKeyForType

protected Object getCacheKeyForType(String type)
                             throws EolModelElementTypeNotFoundException

Description copied from class: CachedModel

Returns an identity for the given type, which will be used by CachedModel as a key for the memoization of model elements by type.

Specified by:

getCacheKeyForType in class CachedModel<Element>

Throws:

EolModelElementTypeNotFoundException

getAllTypeNamesOf

protected Collection<String> getAllTypeNamesOf(Object instance)

Description copied from class: CachedModel

Returns the fully qualified names of every type to which the given object conforms. The values are used by by CachedModel for the memoization of model elements by their kind (CachedModel.getAllOfKind(String)).

Specified by:

getAllTypeNamesOf in class CachedModel<Element>

getTypeOf

public Object getTypeOf(Object instance)

Specified by:

getTypeOf in interface IModel

Overrides:

getTypeOf in class Model

hasType

public boolean hasType(String type)

Specified by:

hasType in interface IModel

isInstantiable

public boolean isInstantiable(String type)

Specified by:

isInstantiable in interface IModel

isModelElement

public boolean isModelElement(Object instance)

Description copied from interface: IModel

Used to test whether a Java object can be contained by this model. For example, EMF models can contain instances of EObject, but not instances of just Object.

Specified by:

isModelElement in interface IModel

Overrides:

isModelElement in class Model

Parameters:

instance - the Java object to test.

Returns:

true if and only if instance can be contained by this model.

loadModel

protected void loadModel()
                  throws EolModelLoadingException

Specified by:

loadModel in class CachedModel<Element>

Throws:

EolModelLoadingException

load

public void load(StringProperties properties,
 IRelativePathResolver resolver)
          throws EolModelLoadingException

Specified by:

load in interface IModel

Overrides:

load in class CachedModel<Element>

Throws:

EolModelLoadingException

owns

public boolean owns(Object instance)

Description copied from interface: IModel

Used to test whether an object is contained in this model.

Specified by:

owns in interface IModel

Parameters:

instance - the Java object to test.

Returns:

true if and only if instance is contained by this model.

store

public boolean store(String location)

Specified by:

store in interface IModel

store

public boolean store()

Specified by:

store in interface IModel

getOperationContributor

public OperationContributor getOperationContributor()

Specified by:

getOperationContributor in interface IOperationContributorProvider