com.ibm.carma.model
Interface ModelFactory

All Superinterfaces:
org.eclipse.emf.ecore.EFactory, org.eclipse.emf.ecore.EModelElement, org.eclipse.emf.ecore.EObject, org.eclipse.emf.common.notify.Notifier

public interface ModelFactory
extends org.eclipse.emf.ecore.EFactory

The Factory for the model. It provides a create method for each non-abstract class of the model. This is an internal class and should not be used outside the CARMA model

See Also:
ModelPackage

Field Summary
static java.lang.String copyright
           
static ModelFactory eINSTANCE
          The singleton instance of the factory.
 
Method Summary
 Action createAction()
          Returns a new object of class 'Action'.
 Action createAction(java.lang.String actionId, java.lang.String name, boolean disabled, java.lang.String desciption, java.util.List<CustomParameter> customParams, java.util.List<ReturnValue> returnValues)
          Returns a new object of class 'Action'.
 CARMA createCARMA()
          Returns a new object of class 'CARMA'.
 CARMA createCARMA(java.lang.String identifier, java.lang.String backendId, java.util.Map<java.lang.String,?> connectionProperties)
          Returns a new object of class 'CARMA'.
 CARMAContainer createCARMAContainer()
          Returns a new object of class 'CARMA Container'.
 CARMAContainer createCARMAContainer(java.lang.String memberId, java.lang.String name, ResourceContainer container)
          Returns a new object of class 'CARMA Container'.
 CARMAContainer createCARMAContainer(java.lang.String memberId, java.lang.String name, ResourceContainer container, java.util.Map<java.lang.String,?> memberInfo)
          Returns a new object of class 'CARMA Container'.
 CARMAMember createCARMAMember()
          Returns a new object of class 'CARMA Member'.
 CARMAMember createCARMAMember(java.lang.String memberId, java.lang.String name, ResourceContainer container)
          Returns a new object of class 'CARMA Member'.
 CARMAMember createCARMAMember(java.lang.String memberId, java.lang.String name, ResourceContainer container, java.util.Map<java.lang.String,?> memberInfo)
          Returns a new object of class 'CARMA Member'.
 CARMAMember createCARMAMember(java.lang.String memberId, java.lang.String name, ResourceContainer container, java.lang.String recFM, int LRecl)
          Returns a new object of class 'CARMA Member'.
 CARMAMemberVersion createCARMAMemberVersion()
          Returns a new object of class 'CARMA Member Version'.
 CARMAMemberVersion createCARMAMemberVersion(java.lang.String memberId, java.lang.String versionId, java.lang.String comment, int index, java.util.Map<java.lang.String,?> memberInfo)
          Returns a new object of class 'CARMA Member Version'.
 CARMAReturn createCARMAReturn()
          Returns a new object of class 'CARMA Return'.
 CARMAReturn createCARMAReturn(java.util.Map<ReturnValue,?> returnContents)
          Returns a new object of class 'CARMA Return' populated with a return contents Map
 CustomParameter createCustomParameter()
          Returns a new object of class 'Custom Parameter'.
 CustomParameter createCustomParameter(CustomParameter param)
          Returns a new object of class 'Custom Parameter'.
 CustomParameter createCustomParameter(Parameter param, java.lang.String prompt, java.lang.Object defaultValue, boolean isConstant)
          Returns a new object of class 'Custom Parameter'.
 CustomParameter createCustomParameter(java.lang.String parameterId, java.lang.String name, java.lang.String description, VariableType type, int length, java.lang.String prompt, java.lang.Object defaultValue, boolean isConstant)
          Returns a new object of class 'Custom Parameter'.
 Field createField()
          Returns a new object of class 'Field'.
 Field createField(Parameter param, java.lang.Object defaultValue, java.lang.String memberInfoKey)
          Returns a new object of class 'Field'.
 Field createField(java.lang.String fieldId, java.lang.String name, java.lang.String description, VariableType type, int length, java.lang.Object defaultValue, java.lang.String memberInfoKey)
          Returns a new object of class 'Field'.
 RepositoryInstance createRepositoryInstance()
          Returns a new object of class 'Repository Instance'.
 RepositoryInstance createRepositoryInstance(java.lang.String memberId, java.lang.String name)
          Returns a new object of class 'Repository Instance'.
 RepositoryInstance createRepositoryInstance(java.lang.String memberId, java.lang.String name, java.util.Map<java.lang.String,?> memberInfo)
          Returns a new object of class 'Repository Instance'.
 RepositoryManager createRepositoryManager()
          Returns a new object of class 'Repository Manager'.
 RepositoryManager createRepositoryManager(java.lang.String managerId, java.lang.String name, java.lang.String version, java.lang.String level, java.lang.String description)
          Returns a new object of class 'Repository Manager'.
 ReturnValue createReturnValue()
          Returns a new object of class 'Return Value'.
 ReturnValue createReturnValue(Parameter parameter)
          Returns a new object of class 'Return Value'.
 ReturnValue createReturnValue(java.lang.String parameterId, java.lang.String name, java.lang.String description, VariableType type, int length)
          Returns a new object of class 'Return Value'.
 ModelPackage getModelPackage()
          Returns the package supported by this factory.
 
Methods inherited from interface org.eclipse.emf.ecore.EFactory
convertToString, create, createFromString, getEPackage, setEPackage
 
Methods inherited from interface org.eclipse.emf.ecore.EModelElement
getEAnnotation, getEAnnotations
 
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
 

Field Detail

copyright

static final java.lang.String copyright

See Also:
Constant Field Values

eINSTANCE

static final ModelFactory eINSTANCE
The singleton instance of the factory.

Method Detail

createCARMA

CARMA createCARMA()
Returns a new object of class 'CARMA'.

Returns:
a new object of class 'CARMA'.

createCARMA

CARMA createCARMA(java.lang.String identifier,
                  java.lang.String backendId,
                  java.util.Map<java.lang.String,?> connectionProperties)
                  throws java.lang.Exception
Returns a new object of class 'CARMA'.

Parameters:
identifier - unique CARMA identifier
backendId - Backend persistence layer identifier
connectionProperties - properties used to configure persistence layer connection
Returns:
a new object of class 'CARMA'.
Throws:
java.lang.Exception

createCARMAMember

CARMAMember createCARMAMember()
Returns a new object of class 'CARMA Member'.

Returns:
a new object of class 'CARMA Member'.

createCARMAMember

CARMAMember createCARMAMember(java.lang.String memberId,
                              java.lang.String name,
                              ResourceContainer container)
Returns a new object of class 'CARMA Member'.

Parameters:
memberId - The identifer of the member to create
name - name of the member to create
container - container parent of the member to create
Returns:
a new object of class 'CARMA Member'.

createCARMAMember

CARMAMember createCARMAMember(java.lang.String memberId,
                              java.lang.String name,
                              ResourceContainer container,
                              java.util.Map<java.lang.String,?> memberInfo)
Returns a new object of class 'CARMA Member'.

Parameters:
memberId - The identifer of the member to create
name - name of the member to create
container - container parent of the member to create
memberInfo - initial map of member information for the member
Returns:
a new object of class 'CARMA Member'.

createCARMAMember

CARMAMember createCARMAMember(java.lang.String memberId,
                              java.lang.String name,
                              ResourceContainer container,
                              java.lang.String recFM,
                              int LRecl)
Returns a new object of class 'CARMA Member'.

Parameters:
memberId - The identifer of the member to create
name - name of the member to create
container - container parent of the member to create
recFM - The record format of the member to create
LRecl - the record length of the member to create
Returns:
a new object of class 'CARMA Member'.

createRepositoryInstance

RepositoryInstance createRepositoryInstance()
Returns a new object of class 'Repository Instance'.

Returns:
a new object of class 'Repository Instance'.

createRepositoryInstance

RepositoryInstance createRepositoryInstance(java.lang.String memberId,
                                            java.lang.String name)
Returns a new object of class 'Repository Instance'.

Parameters:
memberId - The identifier of the repository instance to create
name - The name of the repository instance to create
Returns:
a new object of class 'Repository Instance'.

createRepositoryInstance

RepositoryInstance createRepositoryInstance(java.lang.String memberId,
                                            java.lang.String name,
                                            java.util.Map<java.lang.String,?> memberInfo)
Returns a new object of class 'Repository Instance'.

Parameters:
memberId - The identifier of the repository instance to create
name - The name of the repository instance to create
memberInfo - initial map of member information for the container
Returns:
a new object of class 'Repository Instance'.

createRepositoryManager

RepositoryManager createRepositoryManager()
Returns a new object of class 'Repository Manager'.

Returns:
a new object of class 'Repository Manager'.

createRepositoryManager

RepositoryManager createRepositoryManager(java.lang.String managerId,
                                          java.lang.String name,
                                          java.lang.String version,
                                          java.lang.String level,
                                          java.lang.String description)
Returns a new object of class 'Repository Manager'.

Parameters:
managerId - Identifer of the manager to create
name - name of the repository manager to create
version - version of the repository manager to create
level - level of the repository manager to create
description - description of the repository manager to create
Returns:
a new object of class 'Repository Manager'.

createAction

Action createAction()
Returns a new object of class 'Action'.

Returns:
a new object of class 'Action'.

createAction

Action createAction(java.lang.String actionId,
                    java.lang.String name,
                    boolean disabled,
                    java.lang.String desciption,
                    java.util.List<CustomParameter> customParams,
                    java.util.List<ReturnValue> returnValues)
Returns a new object of class 'Action'.

Parameters:
actionId - Identifier of the action to create
name - name of the action to create
disabled - Should the new action be disabled?
desciption - a new object of class 'Action'.
Returns:
new object of class 'Action'

createField

Field createField()
Returns a new object of class 'Field'.

Returns:
a new object of class 'Field'.

createField

Field createField(java.lang.String fieldId,
                  java.lang.String name,
                  java.lang.String description,
                  VariableType type,
                  int length,
                  java.lang.Object defaultValue,
                  java.lang.String memberInfoKey)
Returns a new object of class 'Field'.

Parameters:
fieldId - identifier of the field
name - (displayable) name of the field
description - description of the field
type - type of the field
length - length of the field
defaultValue - default value of the field
memberInfoKey - the member info key referenced by the field
Returns:
a new object of class 'Field'.
Since:
7.1

createField

Field createField(Parameter param,
                  java.lang.Object defaultValue,
                  java.lang.String memberInfoKey)
Returns a new object of class 'Field'.

Parameters:
param - the parameter to use as a basis for the custom parameter. Values of attributes will be copied to the new object
defaultValue - the default value of the field
memberInfoKey - the member info key the field references
Returns:
a new object of class 'Field'.
Since:
7.1

createCARMAContainer

CARMAContainer createCARMAContainer()
Returns a new object of class 'CARMA Container'.

Returns:
a new object of class 'CARMA Container'.

createCARMAContainer

CARMAContainer createCARMAContainer(java.lang.String memberId,
                                    java.lang.String name,
                                    ResourceContainer container)
Returns a new object of class 'CARMA Container'.

Parameters:
memberId - Identifier of the container
name - name of the container
container - parent container for of the CARMA container
Returns:
a new object of class 'CARMA Container'.

createCARMAContainer

CARMAContainer createCARMAContainer(java.lang.String memberId,
                                    java.lang.String name,
                                    ResourceContainer container,
                                    java.util.Map<java.lang.String,?> memberInfo)
Returns a new object of class 'CARMA Container'.

Parameters:
memberId - Identifier of the container
name - name of the container
container - parent container for of the CARMA container
memberInfo - initial map of member information for the container
Returns:
a new object of class 'CARMA Container'.

createReturnValue

ReturnValue createReturnValue()
Returns a new object of class 'Return Value'.

Returns:
a new object of class 'Return Value'.

createReturnValue

ReturnValue createReturnValue(java.lang.String parameterId,
                              java.lang.String name,
                              java.lang.String description,
                              VariableType type,
                              int length)
Returns a new object of class 'Return Value'.

Parameters:
parameterId - the identifier of the return value
name - the name of the return value
description - the description of the return value
type - the (object) type of the return value
length - the maximum length of the return value
Returns:
a new object of class 'Return Value'.

createReturnValue

ReturnValue createReturnValue(Parameter parameter)
Returns a new object of class 'Return Value'.

Parameters:
parameter - the parameter to use as a basis for the custom parameter. Values of attributes will be copied to the new object
Returns:
a new object of class 'Return Value'.

createCustomParameter

CustomParameter createCustomParameter()
Returns a new object of class 'Custom Parameter'.

Returns:
a new object of class 'Custom Parameter'.

createCARMAReturn

CARMAReturn createCARMAReturn()
Returns a new object of class 'CARMA Return'.

Returns:
a new object of class 'CARMA Return'.

createCARMAMemberVersion

CARMAMemberVersion createCARMAMemberVersion()
Returns a new object of class 'CARMA Member Version'.

Returns:
a new object of class 'CARMA Member Version'.

createCARMAMemberVersion

CARMAMemberVersion createCARMAMemberVersion(java.lang.String memberId,
                                            java.lang.String versionId,
                                            java.lang.String comment,
                                            int index,
                                            java.util.Map<java.lang.String,?> memberInfo)
Returns a new object of class 'CARMA Member Version'.

Parameters:
memberId - CARMA identifier of the versioned member
versionId - (Displayable) version description of the member version
comment - comment associated with the member version
index - the index of the version in the version list
memberInfo - member info for the versioned member
Returns:
Since:
7.1

createCARMAReturn

CARMAReturn createCARMAReturn(java.util.Map<ReturnValue,?> returnContents)
Returns a new object of class 'CARMA Return' populated with a return contents Map

Parameters:
returnContents - the map of return value key-value pairs
Returns:
a new object of class 'CARMA Return'.

createCustomParameter

CustomParameter createCustomParameter(java.lang.String parameterId,
                                      java.lang.String name,
                                      java.lang.String description,
                                      VariableType type,
                                      int length,
                                      java.lang.String prompt,
                                      java.lang.Object defaultValue,
                                      boolean isConstant)
Returns a new object of class 'Custom Parameter'.

Parameters:
parameterId - Identifier of the parameter
name - name of the parameter
description - description of the parameter
type - the (object type of the parameter
length - the maximum length of the parameter
prompt - the prompt to display when querying for the parameter value
defaultValue - the default value of the parameter
isConstant - set the parameter to contstant?
Returns:
a new object of class 'Custom Parameter'.

createCustomParameter

CustomParameter createCustomParameter(Parameter param,
                                      java.lang.String prompt,
                                      java.lang.Object defaultValue,
                                      boolean isConstant)
Returns a new object of class 'Custom Parameter'.

Parameters:
param - the parameter to use as a basis for the custom parameter. Values of attributes will be copied to the new object
prompt - the prompt to display when querying for the parameter value
defaultValue - the default value of the parameter
isConstant - set the parameter to contstant?
Returns:
a new object of class 'Custom Parameter'.

createCustomParameter

CustomParameter createCustomParameter(CustomParameter param)
Returns a new object of class 'Custom Parameter'.

Parameters:
param - the parameter to use as a basis for the custom parameter. Values of attributes will be copied to the new object
Returns:
a new object of class 'Custom Parameter'.

getModelPackage

ModelPackage getModelPackage()
Returns the package supported by this factory.

Returns:
the package supported by this factory.