Package org.eclipse.epsilon.emc.json

Class JsonModel

java.lang.Object

org.eclipse.epsilon.eol.models.Model

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

org.eclipse.epsilon.emc.json.JsonModel

All Implemented Interfaces:

AutoCloseable, IModel

public class JsonModel
extends CachedModel<Object>

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 Object	_root
protected File	file
protected Map<String,String>	headers
static final String	JSON_ARRAY_TYPE
static final String	JSON_OBJECT_TYPE
protected String	password
static final String	PROPERTY_FILE
static final String	PROPERTY_HEADER_PREFIX
static final char	PROPERTY_HEADER_SEPARATOR
static final String	PROPERTY_PASSWORD
static final String	PROPERTY_URI
static final String	PROPERTY_USERNAME
protected String	uri
protected String	username

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
JsonModel()

Method Summary

Modifier and Type	Method	Description
protected Collection<Object>	allContentsFromModel()
protected Object	createInstanceInModel(String type)
static Object	deepClone(Object parsed)
protected boolean	deleteElementInModel(Object instance)	Returns true iff the given instance was deleted from the model.
protected void	disposeModel()
protected Collection<Object>	getAllOfKindFromModel(String kind)
protected Collection<Object>	getAllOfTypeFromModel(String type)
protected Collection<String>	getAllTypeNamesOf(Object instance)	Returns the fully qualified names of every type to which the given object conforms.
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.
Object	getElementById(String id)
String	getElementId(Object instance)
Object	getEnumerationValue(String enumeration, String label)
File	getFile()
String	getHeader(String name)
String	getPassword()
Object	getRoot()
String	getTypeNameOf(Object instance)	Returns a string representing the type of the instance object.
String	getUri()
String	getUsername()
boolean	hasType(String type)
boolean	isInstantiable(String type)
boolean	isLoaded()	Convenience method for determining when a model has been loaded.
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	setHeader(String name, String value)
void	setJsonContent(String s)	Convenience method for loading the JSON content directly from a string, instead of loading it from a file or URI.
void	setPassword(String password)
void	setRoot(Object root)
void	setUri(String uri)
void	setUsername(String username)
boolean	store()
boolean	store(String location)
String	toString()

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, createInstance, getAliases, getFullyQualifiedTypeNameOf, getMetamodel, getName, getPropertyGetter, getPropertySetter, getTransactionSupport, getTypeOf, isModelElement, 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, wait, wait, wait

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

checkAmbiguity, close

Field Details

JSON_ARRAY_TYPE

public static final String JSON_ARRAY_TYPE

See Also:

• Constant Field Values

JSON_OBJECT_TYPE

public static final String JSON_OBJECT_TYPE

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

PROPERTY_USERNAME

public static final String PROPERTY_USERNAME

See Also:

• Constant Field Values

PROPERTY_PASSWORD

public static final String PROPERTY_PASSWORD

See Also:

• Constant Field Values

PROPERTY_HEADER_PREFIX

public static final String PROPERTY_HEADER_PREFIX

See Also:

• Constant Field Values

PROPERTY_HEADER_SEPARATOR

public static final char PROPERTY_HEADER_SEPARATOR

See Also:

• Constant Field Values

file

protected File file

uri

protected String uri

username

protected String username

password

protected String password

headers

protected Map<String,String> headers

_root

protected Object _root

Constructor Details

JsonModel

public JsonModel()

Method Details

getRoot

public Object getRoot()

setRoot

public void setRoot(Object root)

setFile

public void setFile(File file)

getFile

public File getFile()

setUri

public void setUri(String uri)

getUri

public String getUri()

setUsername

public void setUsername(String username)

getUsername

public String getUsername()

setPassword

public void setPassword(String password)

getPassword

public String getPassword()

getEnumerationValue

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

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.

Parameters:

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

Returns:

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

getElementById

public Object getElementById(String id)

getElementId

public String getElementId(Object instance)

setElementId

public void setElementId(Object instance,
 String newId)

owns

public boolean owns(Object instance)

Description copied from interface: IModel

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

Parameters:

instance - the Java object to test.

Returns:

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

isInstantiable

public boolean isInstantiable(String type)

hasType

public boolean hasType(String type)

store

public boolean store(String location)

store

public boolean store()

allContentsFromModel

protected Collection<Object> allContentsFromModel()

Specified by:

allContentsFromModel in class CachedModel<Object>

getAllOfTypeFromModel

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

Specified by:

getAllOfTypeFromModel in class CachedModel<Object>

Throws:

EolModelElementTypeNotFoundException

getAllOfKindFromModel

protected Collection<Object> getAllOfKindFromModel(String kind)
                                            throws EolModelElementTypeNotFoundException

Specified by:

getAllOfKindFromModel in class CachedModel<Object>

Throws:

EolModelElementTypeNotFoundException

createInstanceInModel

protected Object createInstanceInModel(String type)
                                throws EolModelElementTypeNotFoundException,
EolNotInstantiableModelElementTypeException

Specified by:

createInstanceInModel in class CachedModel<Object>

Throws:

EolModelElementTypeNotFoundException

EolNotInstantiableModelElementTypeException

load

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

Specified by:

load in interface IModel

Overrides:

load in class CachedModel<Object>

Throws:

EolModelLoadingException

loadModel

protected void loadModel()
                  throws EolModelLoadingException

Specified by:

loadModel in class CachedModel<Object>

Throws:

EolModelLoadingException

deepClone

public static Object deepClone(Object parsed)

disposeModel

protected void disposeModel()

Specified by:

disposeModel in class CachedModel<Object>

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<Object>

Throws:

EolRuntimeException

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<Object>

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<Object>

isLoaded

public boolean isLoaded()

Description copied from class: CachedModel

Convenience method for determining when a model has been loaded.

Overrides:

isLoaded in class CachedModel<Object>

Returns:

Whether the cache has been populated.

getHeader

public String getHeader(String name)

setHeader

public void setHeader(String name,
 String value)

toString

public String toString()

Overrides:

toString in class Object

setJsonContent

public void setJsonContent(String s)

Convenience method for loading the JSON content directly from a string, instead of loading it from a file or URI. The model will consider itself loaded.