org.eclipse.emf.codegen.ecore.genmodel
Interface GenClass

All Superinterfaces:
EObject, GenBase, GenClassifier, Notifier
All Known Implementing Classes:
GenClassImpl

public interface GenClass
extends GenClassifier

A representation of the model object 'Gen Class'.

The following features are supported:

See Also:
GenModelPackage.getGenClass()

Method Summary
 String getAbstractFlag()
           
 List getAllBaseGenClasses()
           
 List getAllChildrenFeatures()
           
 List getAllCreateChildFeatures()
           
 List getAllCreateChildFeaturesIncludingDelegation()
           
 List getAllEVirtualIndexBitFields(List allEVirtualIndexBitFields)
           
 List getAllGenFeatures()
           
 List getAllGenOperations()
           
 GenClass getBaseGenClass()
          This returns the GenClass for the first immediate supertype.
 List getBaseGenClasses()
           
 String getCastFromEObject()
           
 List getChildrenClasses(GenFeature genFeature)
           
 List getChildrenFeatures()
           
 String getClassExtends()
           
 GenClass getClassExtendsGenClass()
          This walks up the chain of GenClasses defined by getBaseGenClass() and returns the first that does not represent an abstract class or an interface; that is, the instantiable class that the implementation class should extended.
 String getClassImplements()
           
 String getClassName()
           
 List getContentNotifyFeatures()
           
 List getCreateChildFeatures()
           
 String getCreateChildIconFileName(GenFeature feature, GenClass childClass)
           
 List getCrossPackageChildrenClasses(GenFeature genFeature)
           
 List getCrossPackageCreateChildFeatures()
           
 List getDeclaredFieldGenFeatures()
           
 List getDeclaredGenFeatures()
           
 List getDeclaredGenOperations()
           
 List getEBasicRemoveFromContainerGenFeatures()
           
 EClass getEcoreClass()
          Returns the value of the 'Ecore Class' reference
 List getEInverseAddGenFeatures()
           
 List getEInverseRemoveGenFeatures()
           
 int getESetFlagIndex(GenFeature genFeature)
           
 String getESetFlagsField(GenFeature genFeature)
           
 List getESetGenFeatures()
           
 List getEVirtualIndexBitFields(List eVirtualIndexBitFields)
           
 String getEVirtualValuesField()
           
 List getExtendedGenClasses()
           
 List getExtendedGenFeatures()
           
 List getExtendedGenOperations()
           
 int getFeatureCount()
           
 String getFeatureCountID()
           
 String getFeatureCountValue()
           
 String getFeatureID(GenFeature genFeature)
           
 String getFeatureValue(GenFeature genFeature)
           
 List getFlagGenFeatures()
           
 List getFlagGenFeatures(String staticDefaultValue)
           
 int getFlagIndex(GenFeature genFeature)
           
 String getFlagsField(GenFeature genFeature)
           
 EList getGenFeatures()
          Returns the value of the 'Gen Features' containment reference list.
 EList getGenOperations()
          Returns the value of the 'Gen Operations' containment reference list.
 List getImplementedGenClasses()
           
 List getImplementedGenFeatures()
           
 List getImplementedGenOperations()
           
 GenModel getImplementingGenModel(GenFeature genFeature)
           
 String getImportedClassName()
           
 String getImportedInterfaceName()
           
 String getImportedProviderClassName()
           
 String getImportedTestCaseClassName()
           
 List getInheritedGenFeatures()
           
 String getInterfaceExtends()
           
 String getInterfaceFlag()
           
 String getInterfaceName()
          This should only be called when there is actually an interface being generated (i.e. when, for certain, this is not an external interface).
 GenOperation getInvariantOperation(String constraint)
           
 List getInvariantOperations()
           
 String getItemIconFileName()
           
 String getItemProviderAdapterFactoryClassName()
           
 List getLabelAndContentNotifyFeatures()
           
 GenFeature getLabelFeature()
          Returns the value of the 'Label Feature' reference
 List getLabelFeatureCandidates()
           
 List getLabelNotifyFeatures()
           
 String getListConstructor(GenFeature genFeature)
           
 String getLocalFeatureIndex(GenFeature genFeature)
           
 GenFeature getMapEntryKeyFeature()
           
 GenFeature getMapEntryValueFeature()
           
 GenFeature getMixedGenFeature()
           
 List getMixinGenClasses()
           
 List getMixinGenFeatures()
           
 List getMixinGenOperations()
           
 String getModelInfo()
           
 List getNotifyFeatures()
           
 String getOperationID(GenOperation genOperation)
           
 List getPropertyFeatures()
           
 GenProviderKind getProvider()
          Returns the value of the 'Provider' attribute.
 String getProviderBaseClassName()
           
 String getProviderClassName()
           
 List getProviderImplementedGenClasses()
           
 String getQualifiedClassName()
           
 String getQualifiedFeatureCountID()
           
 String getQualifiedFeatureID(GenFeature genFeature)
           
 String getQualifiedInterfaceName()
           
 String getQualifiedProviderClassName()
           
 String getQualifiedTestCaseClassName()
           
 List getSharedClassCreateChildFeatures()
           
 List getSwitchGenClasses()
          Like getAllBaseGenClasses(), this returns the GenClasses for all of the supertypes, but the result is ordered by a breadth-first search, making it appropriate for use in the switch class.
 String getTestCaseClassName()
           
 List getToStringGenFeatures()
           
 String getUncapName()
          This returns the name uncapitalized.
 boolean hasFactoryInterfaceCreateMethod()
           
 boolean hasFeatureMapCreateChildFeatures()
           
 boolean hasTests()
           
 boolean implementsAny(Collection genFeatures)
           
 void initialize(EClass eClass)
           
 boolean isAbstract()
           
 boolean isDocumentRoot()
           
 boolean isDynamic()
          Returns the value of the 'Dynamic' attribute
 boolean isEObject()
           
 boolean isEObjectExtension()
           
 boolean isESetField(GenFeature genFeature)
           
 boolean isESetFlag(GenFeature genFeature)
           
 boolean isExternalInterface()
          This indicates that there is already an existing interface for this class or interface, so none will be generated.
 boolean isField(GenFeature genFeature)
           
 boolean isFlag(GenFeature genFeature)
           
 boolean isImage()
          Returns the value of the 'Image' attribute.
 boolean isInterface()
           
 boolean isJavaIOSerializable()
           
 boolean isMapEntry()
           
 boolean isModelRoot()
           
 boolean isProviderSingleton()
           
 boolean needsRootExtendsInterfaceExtendsTag()
           
 boolean reconcile(GenClass oldGenClassVersion)
           
 void setDynamic(boolean value)
          Sets the value of the 'Dynamic' attribute
 void setEcoreClass(EClass value)
          Sets the value of the 'Ecore Class' reference
 void setImage(boolean value)
          Sets the value of the 'Image' attribute
 void setLabelFeature(GenFeature value)
          Sets the value of the 'Label Feature' reference
 void setProvider(GenProviderKind value)
          Sets the value of the 'Provider' attribute
 
Methods inherited from interface org.eclipse.emf.codegen.ecore.genmodel.GenClassifier
getAllGenConstraints, getClassifierAccessorName, getClassifierID, getClassifierInstanceName, getConstraintDelegate, getConstraintImplementor, getEcoreClassifier, getFormattedName, getGenConstraints, getGeneratedInstanceClassFlag, getGenPackage, getImportedInstanceClassName, getImportedMetaType, getMetaType, getName, getQualifiedClassifierAccessor, getSafeUncapName, hasOnlyDefaultConstraints
 
Methods inherited from interface org.eclipse.emf.codegen.ecore.genmodel.GenBase
canGenerate, canGenerateEdit, canGenerateEditor, canGenerateSchema, canGenerateTests, capName, format, gen, genEdit, genEditor, generate, generate, generateEdit, generateEdit, generateEditor, generateEditor, generateSchema, generateSchema, generateTests, generateTests, genSchema, genTests, getDocumentation, getEcoreModelElement, getGenAnnotation, getGenAnnotations, getGenModel, hasDocumentation, reconcile, safeName, uncapName, uncapPrefixedName
 
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

getProvider

public GenProviderKind getProvider()
Returns the value of the 'Provider' attribute. The literals are from the enumeration GenProviderKind.

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

Returns:
the value of the 'Provider' attribute.
See Also:
GenProviderKind, setProvider(GenProviderKind), GenModelPackage.getGenClass_Provider()

setProvider

public void setProvider(GenProviderKind value)
Sets the value of the 'Provider' attribute.

Parameters:
value - the new value of the 'Provider' attribute.
See Also:
GenProviderKind, getProvider()

isImage

public boolean isImage()
Returns the value of the 'Image' attribute. The default value is "true".

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

Returns:
the value of the 'Image' attribute.
See Also:
setImage(boolean), GenModelPackage.getGenClass_Image()

setImage

public void setImage(boolean value)
Sets the value of the 'Image' attribute.

Parameters:
value - the new value of the 'Image' attribute.
See Also:
isImage()

isDynamic

public boolean isDynamic()
Returns the value of the 'Dynamic' attribute.

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

Returns:
the value of the 'Dynamic' attribute.
See Also:
setDynamic(boolean), GenModelPackage.getGenClass_Dynamic()

setDynamic

public void setDynamic(boolean value)
Sets the value of the 'Dynamic' attribute.

Parameters:
value - the new value of the 'Dynamic' attribute.
See Also:
isDynamic()

getEcoreClass

public EClass getEcoreClass()
Returns the value of the 'Ecore Class' reference.

If the meaning of the 'Ecore Class' reference isn't clear, there really should be more of a description here...

Returns:
the value of the 'Ecore Class' reference.
See Also:
setEcoreClass(EClass), GenModelPackage.getGenClass_EcoreClass()

setEcoreClass

public void setEcoreClass(EClass value)
Sets the value of the 'Ecore Class' reference.

Parameters:
value - the new value of the 'Ecore Class' reference.
See Also:
getEcoreClass()

getGenFeatures

public EList getGenFeatures()
Returns the value of the 'Gen Features' containment reference list. The list contents are of type GenFeature. It is bidirectional and its opposite is 'Gen Class'.

If the meaning of the 'Gen Features' reference list isn't clear, there really should be more of a description here...

Returns:
the value of the 'Gen Features' containment reference list.
See Also:
GenModelPackage.getGenClass_GenFeatures(), GenFeature.getGenClass()

getGenOperations

public EList getGenOperations()
Returns the value of the 'Gen Operations' containment reference list. The list contents are of type GenOperation. It is bidirectional and its opposite is 'Gen Class'.

If the meaning of the 'Gen Operations' reference list isn't clear, there really should be more of a description here...

Returns:
the value of the 'Gen Operations' containment reference list.
See Also:
GenModelPackage.getGenClass_GenOperations(), GenOperation.getGenClass()

getLabelFeature

public GenFeature getLabelFeature()
Returns the value of the 'Label Feature' reference.

If the meaning of the 'Label Feature' reference isn't clear, there really should be more of a description here...

Returns:
the value of the 'Label Feature' reference.
See Also:
setLabelFeature(GenFeature), GenModelPackage.getGenClass_LabelFeature()

setLabelFeature

public void setLabelFeature(GenFeature value)
Sets the value of the 'Label Feature' reference.

Parameters:
value - the new value of the 'Label Feature' reference.
See Also:
getLabelFeature()

getInterfaceName

public String getInterfaceName()
This should only be called when there is actually an interface being generated (i.e. when, for certain, this is not an external interface). Otherwise, getImportedInterfaceName() should be used.


getQualifiedInterfaceName

public String getQualifiedInterfaceName()

getImportedInterfaceName

public String getImportedInterfaceName()

getClassName

public String getClassName()

getQualifiedClassName

public String getQualifiedClassName()

getImportedClassName

public String getImportedClassName()

getUncapName

public String getUncapName()
This returns the name uncapitalized. Callers that plan to use this name without appending a suffix should call getSafeUncapInterfaceName() to make sure it's not a reserved word.


getBaseGenClasses

public List getBaseGenClasses()

getAllBaseGenClasses

public List getAllBaseGenClasses()

getSwitchGenClasses

public List getSwitchGenClasses()
Like getAllBaseGenClasses(), this returns the GenClasses for all of the supertypes, but the result is ordered by a breadth-first search, making it appropriate for use in the switch class.


getBaseGenClass

public GenClass getBaseGenClass()
This returns the GenClass for the first immediate supertype.


getClassExtendsGenClass

public GenClass getClassExtendsGenClass()
This walks up the chain of GenClasses defined by getBaseGenClass() and returns the first that does not represent an abstract class or an interface; that is, the instantiable class that the implementation class should extended.


getClassExtends

public String getClassExtends()

getClassImplements

public String getClassImplements()

getInterfaceExtends

public String getInterfaceExtends()

needsRootExtendsInterfaceExtendsTag

public boolean needsRootExtendsInterfaceExtendsTag()

getAllGenFeatures

public List getAllGenFeatures()

getInheritedGenFeatures

public List getInheritedGenFeatures()

getAllGenOperations

public List getAllGenOperations()

getFeatureID

public String getFeatureID(GenFeature genFeature)

getQualifiedFeatureID

public String getQualifiedFeatureID(GenFeature genFeature)

getOperationID

public String getOperationID(GenOperation genOperation)

getFeatureValue

public String getFeatureValue(GenFeature genFeature)

getLocalFeatureIndex

public String getLocalFeatureIndex(GenFeature genFeature)

getFlagsField

public String getFlagsField(GenFeature genFeature)

getFlagIndex

public int getFlagIndex(GenFeature genFeature)

getESetFlagsField

public String getESetFlagsField(GenFeature genFeature)

getESetFlagIndex

public int getESetFlagIndex(GenFeature genFeature)

getFeatureCountID

public String getFeatureCountID()

getQualifiedFeatureCountID

public String getQualifiedFeatureCountID()

getFeatureCountValue

public String getFeatureCountValue()

getFeatureCount

public int getFeatureCount()

isEObject

public boolean isEObject()

isEObjectExtension

public boolean isEObjectExtension()

getCastFromEObject

public String getCastFromEObject()

isAbstract

public boolean isAbstract()

getAbstractFlag

public String getAbstractFlag()

isInterface

public boolean isInterface()

getInterfaceFlag

public String getInterfaceFlag()

isExternalInterface

public boolean isExternalInterface()
This indicates that there is already an existing interface for this class or interface, so none will be generated. Any other generated that wishes to refer to its interface should use the value from getQualifiedInterfaceName() or getImportedInterfaceName().


isMapEntry

public boolean isMapEntry()

getMapEntryKeyFeature

public GenFeature getMapEntryKeyFeature()

getMapEntryValueFeature

public GenFeature getMapEntryValueFeature()

getImplementedGenClasses

public List getImplementedGenClasses()

getImplementedGenFeatures

public List getImplementedGenFeatures()

getImplementedGenOperations

public List getImplementedGenOperations()

getImplementingGenModel

public GenModel getImplementingGenModel(GenFeature genFeature)

implementsAny

public boolean implementsAny(Collection genFeatures)

getExtendedGenClasses

public List getExtendedGenClasses()

getExtendedGenFeatures

public List getExtendedGenFeatures()

getExtendedGenOperations

public List getExtendedGenOperations()

getDeclaredFieldGenFeatures

public List getDeclaredFieldGenFeatures()

getDeclaredGenFeatures

public List getDeclaredGenFeatures()

getDeclaredGenOperations

public List getDeclaredGenOperations()

getFlagGenFeatures

public List getFlagGenFeatures()

getFlagGenFeatures

public List getFlagGenFeatures(String staticDefaultValue)

getESetGenFeatures

public List getESetGenFeatures()

getEInverseAddGenFeatures

public List getEInverseAddGenFeatures()

getEInverseRemoveGenFeatures

public List getEInverseRemoveGenFeatures()

getEBasicRemoveFromContainerGenFeatures

public List getEBasicRemoveFromContainerGenFeatures()

getToStringGenFeatures

public List getToStringGenFeatures()

getMixinGenClasses

public List getMixinGenClasses()

getMixinGenFeatures

public List getMixinGenFeatures()

getMixinGenOperations

public List getMixinGenOperations()

initialize

public void initialize(EClass eClass)

getProviderClassName

public String getProviderClassName()

getQualifiedProviderClassName

public String getQualifiedProviderClassName()

getImportedProviderClassName

public String getImportedProviderClassName()

isProviderSingleton

public boolean isProviderSingleton()

getItemIconFileName

public String getItemIconFileName()

getCreateChildIconFileName

public String getCreateChildIconFileName(GenFeature feature,
                                         GenClass childClass)

getProviderBaseClassName

public String getProviderBaseClassName()

getProviderImplementedGenClasses

public List getProviderImplementedGenClasses()

getLabelFeatureCandidates

public List getLabelFeatureCandidates()

getPropertyFeatures

public List getPropertyFeatures()

getNotifyFeatures

public List getNotifyFeatures()

getLabelNotifyFeatures

public List getLabelNotifyFeatures()

getContentNotifyFeatures

public List getContentNotifyFeatures()

getLabelAndContentNotifyFeatures

public List getLabelAndContentNotifyFeatures()

getChildrenFeatures

public List getChildrenFeatures()

getAllChildrenFeatures

public List getAllChildrenFeatures()

getCreateChildFeatures

public List getCreateChildFeatures()

getAllCreateChildFeatures

public List getAllCreateChildFeatures()

getAllCreateChildFeaturesIncludingDelegation

public List getAllCreateChildFeaturesIncludingDelegation()

getCrossPackageCreateChildFeatures

public List getCrossPackageCreateChildFeatures()

getSharedClassCreateChildFeatures

public List getSharedClassCreateChildFeatures()

hasFeatureMapCreateChildFeatures

public boolean hasFeatureMapCreateChildFeatures()

getChildrenClasses

public List getChildrenClasses(GenFeature genFeature)

getCrossPackageChildrenClasses

public List getCrossPackageChildrenClasses(GenFeature genFeature)

getItemProviderAdapterFactoryClassName

public String getItemProviderAdapterFactoryClassName()

getTestCaseClassName

public String getTestCaseClassName()

getQualifiedTestCaseClassName

public String getQualifiedTestCaseClassName()

getImportedTestCaseClassName

public String getImportedTestCaseClassName()

getModelInfo

public String getModelInfo()

reconcile

public boolean reconcile(GenClass oldGenClassVersion)

getInvariantOperations

public List getInvariantOperations()

getInvariantOperation

public GenOperation getInvariantOperation(String constraint)

isDocumentRoot

public boolean isDocumentRoot()

getMixedGenFeature

public GenFeature getMixedGenFeature()

getListConstructor

public String getListConstructor(GenFeature genFeature)

isModelRoot

public boolean isModelRoot()

isFlag

public boolean isFlag(GenFeature genFeature)

isESetFlag

public boolean isESetFlag(GenFeature genFeature)

isField

public boolean isField(GenFeature genFeature)

isESetField

public boolean isESetField(GenFeature genFeature)

hasTests

public boolean hasTests()

getEVirtualValuesField

public String getEVirtualValuesField()

getEVirtualIndexBitFields

public List getEVirtualIndexBitFields(List eVirtualIndexBitFields)

getAllEVirtualIndexBitFields

public List getAllEVirtualIndexBitFields(List allEVirtualIndexBitFields)

isJavaIOSerializable

public boolean isJavaIOSerializable()

hasFactoryInterfaceCreateMethod

public boolean hasFactoryInterfaceCreateMethod()

Copyright 2001-2006 IBM Corporation and others.
All Rights Reserved.