java.lang.Object
- org.eclipse.epsilon.eol.models.Model
- - org.eclipse.epsilon.emc.hutn.HutnModel

All Implemented Interfaces:: AutoCloseable, IAdaptableModel, IModel, IReflectiveModel

public class HutnModel
extends Model
implements IAdaptableModel, IReflectiveModel

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

static String PROPERTY_SOURCE_FILE
- 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

HutnModel()

HutnModel(String name, String hutn)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`<T> T`	`adaptTo(Class<T> modelType)`	Tries to adapt the model to a different type.
`Collection<?>`	`allContents()`	Returns a collection containing all of the objects contained in this model.
`Object`	`createInstance(String type)`
`void`	`deleteElement(Object instance)`
`Collection<?>`	`getAllOfKind(String type)`
`Collection<?>`	`getAllOfType(String type)`
`Object`	`getContainerOf(Object object)`	Returns the model element that contains the given model element, or null if the given model element is top-level.
`Object`	`getElementById(String id)`
`String`	`getElementId(Object instance)`
`String`	`getEnumerationLabelOf(Object literal)`	Returns the enumeration label of the literal parameter.
`String`	`getEnumerationTypeOf(Object literal)`	Returns the name of the enumeration type of the literal parameter.
`Object`	`getEnumerationValue(String enumeration, String label)`
`Collection<String>`	`getPropertiesOf(String type)`	Returns a collection containing all of the properties that instances of type know about.
`IPropertyGetter`	`getPropertyGetter()`
`IReflectivePropertySetter`	`getPropertySetter()`
`String`	`getTypeNameOf(Object instance)`	Returns a string representing the type of the instance object.
`Object`	`getTypeOf(Object instance)`
`boolean`	`hasPackage(String packageName)`	Returns true iff this model contains a package with the given name.
`boolean`	`hasProperty(String type, String property)`
`boolean`	`hasType(String type)`
`boolean`	`isEnumerationValue(Object object)`	Returns true iff object is an enumeration value.
`boolean`	`isInstantiable(String type)`
`boolean`	`isLoaded()`
`boolean`	`isModelElement(Object instance)`	Used to test whether a Java object can be contained by this model.
`void`	`load()`
`void`	`load(StringProperties properties, IRelativePathResolver resolver)`
`boolean`	`owns(Object instance)`	Used to test whether an object is contained in this model.
`boolean`	`preventLoadingOfExternalModelElements()`	Prevents the loading of model elements that are referenced by this model but are not contained in this model.
`void`	`setElementId(Object instance, String newId)`
`boolean`	`store()`
`boolean`	`store(String location)`
`String`	`toString()`

Methods inherited from class org.eclipse.epsilon.eol.models.Model
allInstances, createInstance, dispose, getAliases, getFullyQualifiedTypeNameOf, getMetamodel, getName, 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, wait, wait, wait

Methods inherited from interface org.eclipse.epsilon.eol.models.IModel
checkAmbiguity, close, createInstance, dispose, getAliases, getFullyQualifiedTypeNameOf, getMetamodel, getName, getTransactionSupport, isOfKind, isOfType, isPropertySet, isReadOnLoad, isStoredOnDisposal, knowsAboutProperty, load, load, setName, setReadOnLoad, setStoredOnDisposal

- Field Detail
  - PROPERTY_SOURCE_FILE
```
public static final String PROPERTY_SOURCE_FILE
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - HutnModel
```
public HutnModel()
```
  - HutnModel
```
public HutnModel(String name,
                 String hutn)
```
- Method Detail
  - preventLoadingOfExternalModelElements
```
public boolean preventLoadingOfExternalModelElements()
```
    Description copied from interface: IReflectiveModel
    
    Prevents the loading of model elements that are referenced by this model but are not contained in this model. This is useful for clients, such as Epsilon Flock, which create a clone or conservative copy of this model.
    
    Specified by:
    
    preventLoadingOfExternalModelElements in interface IReflectiveModel
    
    Returns:
    
    true iff this method had an effect (i.e. when this model supports external references, was configured to load external references and is no longer configured to load external references).
  - load
```
public void load()
          throws EolModelLoadingException
```
    Specified by:
    
    load in interface IModel
    
    Throws:
    
    EolModelLoadingException
  - load
```
public void load(StringProperties properties,
                 IRelativePathResolver resolver)
          throws EolModelLoadingException
```
    Specified by:
    
    load in interface IModel
    
    Overrides:
    
    load in class Model
    
    Throws:
    
    EolModelLoadingException
  - isLoaded
```
public boolean isLoaded()
```
    Since:
    
    1.6
  - getPropertyGetter
```
public IPropertyGetter getPropertyGetter()
```
    Specified by:
    
    getPropertyGetter in interface IModel
    
    Overrides:
    
    getPropertyGetter in class Model
  - getPropertySetter
```
public IReflectivePropertySetter getPropertySetter()
```
    Specified by:
    
    getPropertySetter in interface IModel
    
    Specified by:
    
    getPropertySetter in interface IReflectiveModel
    
    Overrides:
    
    getPropertySetter in class Model
  - store
```
public boolean store(String location)
```
    Specified by:
    
    store in interface IModel
  - store
```
public boolean store()
```
    Specified by:
    
    store in interface IModel
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getEnumerationValue
```
public Object getEnumerationValue(String enumeration,
                                  String label)
                           throws EolEnumerationValueNotFoundException
```
    Specified by:
    
    getEnumerationValue in interface IModel
    
    Throws:
    
    EolEnumerationValueNotFoundException
  - allContents
```
public Collection<?> allContents()
```
    Description copied from interface: IModel
    
    Returns a collection containing all of the objects contained in this model.
    
    Specified by:
    
    allContents in interface IModel
    
    Returns:
    
    all of the objects contained in this model.
  - getAllOfType
```
public Collection<?> getAllOfType(String type)
                           throws EolModelElementTypeNotFoundException
```
    Specified by:
    
    getAllOfType in interface IModel
    
    Throws:
    
    EolModelElementTypeNotFoundException
  - getAllOfKind
```
public Collection<?> getAllOfKind(String type)
                           throws EolModelElementTypeNotFoundException
```
    Specified by:
    
    getAllOfKind in interface IModel
    
    Throws:
    
    EolModelElementTypeNotFoundException
  - getTypeOf
```
public Object getTypeOf(Object instance)
```
    Specified by:
    
    getTypeOf in interface IModel
    
    Overrides:
    
    getTypeOf in class Model
  - 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.
  - createInstance
```
public Object createInstance(String type)
                      throws EolModelElementTypeNotFoundException,
                             EolNotInstantiableModelElementTypeException
```
    Specified by:
    
    createInstance in interface IModel
    
    Throws:
    
    EolModelElementTypeNotFoundException
    
    EolNotInstantiableModelElementTypeException
  - 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
  - deleteElement
```
public void deleteElement(Object instance)
                   throws EolRuntimeException
```
    Specified by:
    
    deleteElement in interface IModel
    
    Throws:
    
    EolRuntimeException
  - 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.
  - 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.
  - hasType
```
public boolean hasType(String type)
```
    Specified by:
    
    hasType in interface IModel
  - hasPackage
```
public boolean hasPackage(String packageName)
```
    Description copied from interface: IReflectiveModel
    
    Returns true iff this model contains a package with the given name. In general, a "package" is a group of types (and potentially other packages) and a namespace for the grouped elements. The precise semantics of "package" is specific to the implementation. For example, an Ecore implementation might use EPackage. An XML implementation might use XML namespaces. A CSV implementation might not support any notion of packages (and hence always return false).
    
    Specified by:
    
    hasPackage in interface IReflectiveModel
  - getContainerOf
```
public Object getContainerOf(Object object)
```
    Description copied from interface: IReflectiveModel
    
    Returns the model element that contains the given model element, or null if the given model element is top-level.
    
    Specified by:
    
    getContainerOf in interface IReflectiveModel
    
    Parameters:
    
    object - The model element whose container is to be found.
    
    Returns:
    
    the model element that contains object, or null if object is not contained in any other model element.
  - getPropertiesOf
```
public Collection<String> getPropertiesOf(String type)
                                   throws EolModelElementTypeNotFoundException
```
    Description copied from interface: IReflectiveModel
    
    Returns a collection containing all of the properties that instances of type know about.
    
    Specified by:
    
    getPropertiesOf in interface IReflectiveModel
    
    Parameters:
    
    type - The type of model object whose properties are to be determined.
    
    Returns:
    
    all of the properties that instances of type knows about.
    
    Throws:
    
    EolModelElementTypeNotFoundException - when this model has no such type
  - hasProperty
```
public boolean hasProperty(String type,
                           String property)
                    throws EolModelElementTypeNotFoundException
```
    Specified by:
    
    hasProperty in interface IReflectiveModel
    
    Throws:
    
    EolModelElementTypeNotFoundException
  - isEnumerationValue
```
public boolean isEnumerationValue(Object object)
```
    Description copied from interface: IReflectiveModel
    
    Returns true iff object is an enumeration value.
    
    Specified by:
    
    isEnumerationValue in interface IReflectiveModel
  - getEnumerationTypeOf
```
public String getEnumerationTypeOf(Object literal)
                            throws EolNotAnEnumerationValueException
```
    Description copied from interface: IReflectiveModel
    
    Returns the name of the enumeration type of the literal parameter.
    
    Specified by:
    
    getEnumerationTypeOf in interface IReflectiveModel
    
    Throws:
    
    EolNotAnEnumerationValueException - when literal is not an enumeration value
  - getEnumerationLabelOf
```
public String getEnumerationLabelOf(Object literal)
                             throws EolNotAnEnumerationValueException
```
    Description copied from interface: IReflectiveModel
    
    Returns the enumeration label of the literal parameter.
    
    Specified by:
    
    getEnumerationLabelOf in interface IReflectiveModel
    
    Throws:
    
    EolNotAnEnumerationValueException - when literal is not an enumeration value
  - adaptTo
```
public <T> T adaptTo(Class<T> modelType)
```
    Description copied from interface: IAdaptableModel
    
    Tries to adapt the model to a different type. If it is not possible, this method should return null.
    
    Specified by:
    
    adaptTo in interface IAdaptableModel
    
    Parameters:
    
    modelType - Type to which this model should be adapted.
    
    Returns:
    
    Non-null value if the model could be adapted, null otherwise.

Constructors
Constructor	Description
`HutnModel()`
`HutnModel(String name, String hutn)`

Class HutnModel

Nested Class Summary

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

Field Summary

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

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

Field Detail

PROPERTY_SOURCE_FILE

Constructor Detail

HutnModel

HutnModel

Method Detail

preventLoadingOfExternalModelElements

load

load

isLoaded

getPropertyGetter

getPropertySetter

store

store

toString

getEnumerationValue

allContents

getAllOfType

getAllOfKind

getTypeOf

getTypeNameOf

createInstance

getElementById

getElementId

setElementId

deleteElement

owns

isInstantiable

isModelElement

hasType

hasPackage

getContainerOf

getPropertiesOf

hasProperty

isEnumerationValue

getEnumerationTypeOf

getEnumerationLabelOf

adaptTo