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

All Superinterfaces:
EObject, GenBase, Notifier
All Known Implementing Classes:
GenPackageImpl

public interface GenPackage
extends GenBase

A representation of the model object 'Gen Package'.

The following features are supported:

See Also:
GenModelPackage.getGenPackage()

Method Summary
 void generateSchema()
          Deprecated. Use GenBase.generateSchema(IProgressMonitor) instead. This method will be removed soon.
 java.lang.String getActionBarContributorClassName()
           
 java.util.List getAdapterDelegatePackages()
           
 java.util.List getAdapterDelegateSuperClasses()
           
 java.lang.String getAdapterFactoryClassName()
           
 java.lang.String getAdapterFactoryDelegateName(GenPackage genDelegate)
           
 java.util.List getAllAnnotations()
           
 java.util.List getAllGenDataTypes()
           
 java.util.List getAllGenFeatures()
           
 java.util.List getAllSwitchGenClasses()
           
 java.util.List getAllValidatorBaseGenPackages()
           
 java.lang.String getAnnotatedModelElementAccessor(EAnnotation eAnnotation)
           
 java.lang.String getAnnotationSourceIdentifier(java.lang.String annotationSource)
           
 java.util.List getAnnotationSources()
           
 java.lang.String getBasePackage()
          Returns the value of the 'Base Package' attribute
 java.lang.String getClassifierID(GenClassifier genClassifier)
           
 int getClassifierValue(GenClassifier genClassifier)
           
 java.lang.String getClassPackageName()
           
 java.lang.String getClassUniqueName(GenClass genClass)
           
 EPackage getEcorePackage()
          Returns the value of the 'Ecore Package' reference
 java.lang.String getEditorClassName()
           
 java.lang.String getEditorPluginClassName()
           
 java.lang.String getEditPluginClassName()
           
 java.lang.String getFactoryClassName()
           
 java.lang.String getFactoryInterfaceName()
           
 EList getGenClasses()
          Returns the value of the 'Gen Classes' containment reference list.
 EList getGenClassifiers()
          Returns the value of the 'Gen Classifiers' reference list.
 EList getGenDataTypes()
          Returns the value of the 'Gen Data Types' containment reference list.
 EList getGenEnums()
          Returns the value of the 'Gen Enums' containment reference list.
 GenModel getGenModel()
          Returns the value of the 'Gen Model' container reference.
 java.lang.String getImportedActionBarContributorClassName()
           
 java.lang.String getImportedAdapterFactoryClassName()
           
 java.lang.String getImportedEditorClassName()
           
 java.lang.String getImportedEditorPluginClassName()
           
 java.lang.String getImportedEditPluginClassName()
           
 java.lang.String getImportedFactoryClassName()
           
 java.lang.String getImportedFactoryInterfaceName()
           
 java.lang.String getImportedItemProviderAdapterFactoryClassName()
           
 java.lang.String getImportedModelWizardClassName()
           
 java.lang.String getImportedPackageClassName()
           
 java.lang.String getImportedPackageInterfaceName()
           
 java.lang.String getImportedResourceBaseClassName()
           
 java.lang.String getImportedResourceClassName()
           
 java.lang.String getImportedResourceFactoryBaseClassName()
           
 java.lang.String getImportedResourceFactoryClassName()
           
 java.lang.String getImportedValidatorClassName()
           
 java.lang.String getInterfacePackageName()
           
 java.lang.String getItemProviderAdapterFactoryClassName()
           
 java.util.List getJavaLangConflicts()
           
 int getLocalClassifierIndex(GenClassifier genClassifier)
           
 java.lang.String getModelWizardClassName()
           
 EList getNestedGenPackages()
          Returns the value of the 'Nested Gen Packages' containment reference list.
 java.lang.String getNSName()
           
 java.lang.String getNSURI()
           
 java.util.List getOrderedGenClasses()
          Returns the list of GenClasses in the GenPackage, ordered such that a class always follows all of the classes it extends.
 java.util.List getOrderedGenClassifiers()
           
 java.util.List getPackageBuildInterDependencies()
           
 java.lang.String getPackageClassName()
           
 java.util.List getPackageInitializationDependencies()
           
 java.lang.String getPackageInstanceVariable(GenPackage genPackage)
           
 java.util.List getPackageInterDependencies()
           
 java.lang.String getPackageInterfaceName()
           
 java.util.List getPackageLoadInterDependencies()
           
 java.lang.String getPackageName()
           
 java.util.List getPackageSimpleDependencies()
           
 java.lang.String getPrefix()
          Returns the value of the 'Prefix' attribute
 java.lang.String getPresentationPackageName()
           
 java.lang.String getProviderPackageName()
           
 java.lang.String getQualifiedActionBarContributorClassName()
           
 java.lang.String getQualifiedAdapterFactoryClassName()
           
 java.lang.String getQualifiedEditorClassName()
           
 java.lang.String getQualifiedEditorPluginClassName()
           
 java.lang.String getQualifiedEditPluginClassName()
           
 java.lang.String getQualifiedFactoryClassName()
           
 java.lang.String getQualifiedFactoryInterfaceName()
           
 java.lang.String getQualifiedItemProviderAdapterFactoryClassName()
           
 java.lang.String getQualifiedModelWizardClassName()
           
 java.lang.String getQualifiedPackageClassName()
           
 java.lang.String getQualifiedPackageInterfaceName()
           
 java.lang.String getQualifiedResourceClassName()
           
 java.lang.String getQualifiedResourceFactoryClassName()
           
 GenResourceKind getResource()
          Returns the value of the 'Resource' attribute.
 java.lang.String getResourceClassName()
           
 java.lang.String getResourceFactoryClassName()
           
 GenPackage getRootGenPackage()
          Returns the top-most GenPackage-typed container for which hasClassifiers() is true, which may be this GenPackage, itself.
 java.lang.String getSerializedPackageFilename()
           
 java.util.List getSubGenPackages()
          Returns a list of those nestedGenPackages for which hasClassifiers() is true.
 GenPackage getSuperGenPackage()
          Returns the closest GenPackage-typed container for which hasClassifiers() is true, or null if there is none.
 java.lang.String getSwitchClassName()
           
 java.lang.String getUncapAdapterFactoryClassName()
           
 java.lang.String getUncapAdapterFactoryDelegateName(GenPackage genDelegate)
           
 java.lang.String getUncapFactoryInterfaceName()
           
 java.lang.String getUncapPackageInterfaceName()
           
 java.lang.String getUtilitiesPackageName()
           
 java.lang.String getValidatorClassName()
           
 java.lang.String getValidatorPackageUniqueSafeName(GenPackage genPackage)
           
 boolean hasClassifiers()
           
 boolean hasConstraints()
           
 boolean hasDocumentRoot()
           
 boolean hasExtendedMetaData()
           
 boolean hasInterfaceImplConflict()
           
 boolean hasJavaLangConflict()
           
 boolean hasTargetNamespace()
           
 boolean hasXMLMap()
           
 void initialize(EPackage ePackage)
           
 boolean isAdapterFactory()
          Returns the value of the 'Adapter Factory' attribute.
 boolean isEcorePackage()
           
 boolean isLoadedInitialization()
          Returns true if this package's root, which may be itself, requires, or has a subpackage that requires, load initialization.
 boolean isLoadingInitialization()
          Returns true if this is a root package that requires, or has a direct or indirect subpackage that requires, load initialization.
 boolean isLoadInitialization()
          Returns the value of the 'Load Initialization' attribute
 boolean reconcile(GenPackage oldGenPackageVersion)
           
 void setAdapterFactory(boolean value)
          Sets the value of the 'Adapter Factory' attribute
 void setBasePackage(java.lang.String value)
          Sets the value of the 'Base Package' attribute
 void setEcorePackage(EPackage value)
          Sets the value of the 'Ecore Package' reference
 void setGenModel(GenModel value)
          Sets the value of the 'Gen Model' container reference
 void setLoadInitialization(boolean value)
          Sets the value of the 'Load Initialization' attribute
 void setPrefix(java.lang.String value)
          Sets the value of the 'Prefix' attribute
 void setResource(GenResourceKind value)
          Sets the value of the 'Resource' attribute
 
Methods inherited from interface org.eclipse.emf.codegen.ecore.genmodel.GenBase
canGenerate, canGenerateEdit, canGenerateEditor, canGenerateSchema, capName, ePackageGenModel, format, generate, generateEdit, generateEditor, generateSchema, getDocumentation, 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

getPrefix

public java.lang.String getPrefix()
Returns the value of the 'Prefix' attribute.

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

Returns:
the value of the 'Prefix' attribute.
See Also:
setPrefix(String), GenModelPackage.getGenPackage_Prefix()

setPrefix

public void setPrefix(java.lang.String value)
Sets the value of the 'Prefix' attribute.

Parameters:
value - the new value of the 'Prefix' attribute.
See Also:
getPrefix()

getBasePackage

public java.lang.String getBasePackage()
Returns the value of the 'Base Package' attribute.

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

Returns:
the value of the 'Base Package' attribute.
See Also:
setBasePackage(String), GenModelPackage.getGenPackage_BasePackage()

setBasePackage

public void setBasePackage(java.lang.String value)
Sets the value of the 'Base Package' attribute.

Parameters:
value - the new value of the 'Base Package' attribute.
See Also:
getBasePackage()

getResource

public GenResourceKind getResource()
Returns the value of the 'Resource' attribute. The literals are from the enumeration GenResourceKind.

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

Returns:
the value of the 'Resource' attribute.
See Also:
GenResourceKind, setResource(GenResourceKind), GenModelPackage.getGenPackage_Resource()

setResource

public void setResource(GenResourceKind value)
Sets the value of the 'Resource' attribute.

Parameters:
value - the new value of the 'Resource' attribute.
See Also:
GenResourceKind, getResource()

isAdapterFactory

public boolean isAdapterFactory()
Returns the value of the 'Adapter Factory' attribute. The default value is "true".

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

Returns:
the value of the 'Adapter Factory' attribute.
See Also:
setAdapterFactory(boolean), GenModelPackage.getGenPackage_AdapterFactory()

setAdapterFactory

public void setAdapterFactory(boolean value)
Sets the value of the 'Adapter Factory' attribute.

Parameters:
value - the new value of the 'Adapter Factory' attribute.
See Also:
isAdapterFactory()

isLoadInitialization

public boolean isLoadInitialization()
Returns the value of the 'Load Initialization' attribute.

If true, the package meta-data will be initialized by loading it from a resource, instead of building it up programmatically. This should be used for large packasges, for which the generated code for building it would excede the 64k method limit.

Returns:
the value of the 'Load Initialization' attribute.
See Also:
setLoadInitialization(boolean), GenModelPackage.getGenPackage_LoadInitialization()

setLoadInitialization

public void setLoadInitialization(boolean value)
Sets the value of the 'Load Initialization' attribute.

Parameters:
value - the new value of the 'Load Initialization' attribute.
See Also:
isLoadInitialization()

getEcorePackage

public EPackage getEcorePackage()
Returns the value of the 'Ecore Package' reference.

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

Returns:
the value of the 'Ecore Package' reference.
See Also:
setEcorePackage(EPackage), GenModelPackage.getGenPackage_EcorePackage()

setEcorePackage

public void setEcorePackage(EPackage value)
Sets the value of the 'Ecore Package' reference.

Parameters:
value - the new value of the 'Ecore Package' reference.
See Also:
getEcorePackage()

getGenModel

public GenModel getGenModel()
Returns the value of the 'Gen Model' container reference. It is bidirectional and its opposite is 'Gen Packages'.

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

Specified by:
getGenModel in interface GenBase
Returns:
the value of the 'Gen Model' container reference.
See Also:
setGenModel(GenModel), GenModelPackage.getGenPackage_GenModel(), GenModel.getGenPackages()

setGenModel

public void setGenModel(GenModel value)
Sets the value of the 'Gen Model' container reference.

Parameters:
value - the new value of the 'Gen Model' container reference.
See Also:
getGenModel()

getGenEnums

public EList getGenEnums()
Returns the value of the 'Gen Enums' containment reference list. The list contents are of type GenEnum.

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

Returns:
the value of the 'Gen Enums' containment reference list.
See Also:
GenModelPackage.getGenPackage_GenEnums()

getGenDataTypes

public EList getGenDataTypes()
Returns the value of the 'Gen Data Types' containment reference list. The list contents are of type GenDataType.

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

Returns:
the value of the 'Gen Data Types' containment reference list.
See Also:
GenModelPackage.getGenPackage_GenDataTypes()

getGenClasses

public EList getGenClasses()
Returns the value of the 'Gen Classes' containment reference list. The list contents are of type GenClass.

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

Returns:
the value of the 'Gen Classes' containment reference list.
See Also:
GenModelPackage.getGenPackage_GenClasses()

getNestedGenPackages

public EList getNestedGenPackages()
Returns the value of the 'Nested Gen Packages' containment reference list. The list contents are of type GenPackage.

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

Returns:
the value of the 'Nested Gen Packages' containment reference list.
See Also:
GenModelPackage.getGenPackage_NestedGenPackages()

getGenClassifiers

public EList getGenClassifiers()
Returns the value of the 'Gen Classifiers' reference list. The list contents are of type GenClassifier. It is bidirectional and its opposite is 'Gen Package'.

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

Returns:
the value of the 'Gen Classifiers' reference list.
See Also:
GenModelPackage.getGenPackage_GenClassifiers(), GenClassifier.getGenPackage()

getInterfacePackageName

public java.lang.String getInterfacePackageName()

getClassPackageName

public java.lang.String getClassPackageName()

getUtilitiesPackageName

public java.lang.String getUtilitiesPackageName()

getNSName

public java.lang.String getNSName()

getNSURI

public java.lang.String getNSURI()

getPackageName

public java.lang.String getPackageName()

getPackageInterfaceName

public java.lang.String getPackageInterfaceName()

getQualifiedPackageInterfaceName

public java.lang.String getQualifiedPackageInterfaceName()

getImportedPackageInterfaceName

public java.lang.String getImportedPackageInterfaceName()

getUncapPackageInterfaceName

public java.lang.String getUncapPackageInterfaceName()

getPackageClassName

public java.lang.String getPackageClassName()

getQualifiedPackageClassName

public java.lang.String getQualifiedPackageClassName()

getImportedPackageClassName

public java.lang.String getImportedPackageClassName()

getFactoryInterfaceName

public java.lang.String getFactoryInterfaceName()

getQualifiedFactoryInterfaceName

public java.lang.String getQualifiedFactoryInterfaceName()

getImportedFactoryInterfaceName

public java.lang.String getImportedFactoryInterfaceName()

getUncapFactoryInterfaceName

public java.lang.String getUncapFactoryInterfaceName()

getFactoryClassName

public java.lang.String getFactoryClassName()

getQualifiedFactoryClassName

public java.lang.String getQualifiedFactoryClassName()

getImportedFactoryClassName

public java.lang.String getImportedFactoryClassName()

getAdapterFactoryClassName

public java.lang.String getAdapterFactoryClassName()

getQualifiedAdapterFactoryClassName

public java.lang.String getQualifiedAdapterFactoryClassName()

getImportedAdapterFactoryClassName

public java.lang.String getImportedAdapterFactoryClassName()

getUncapAdapterFactoryClassName

public java.lang.String getUncapAdapterFactoryClassName()

getSwitchClassName

public java.lang.String getSwitchClassName()

getValidatorClassName

public java.lang.String getValidatorClassName()

getImportedValidatorClassName

public java.lang.String getImportedValidatorClassName()

getAllGenDataTypes

public java.util.List getAllGenDataTypes()

getOrderedGenClasses

public java.util.List getOrderedGenClasses()
Returns the list of GenClasses in the GenPackage, ordered such that a class always follows all of the classes it extends. Appropriate for use in package interface to declare feature constants, which will depend on (and hence must follow) constants for the extended class.


getOrderedGenClassifiers

public java.util.List getOrderedGenClassifiers()

getClassifierID

public java.lang.String getClassifierID(GenClassifier genClassifier)

getClassifierValue

public int getClassifierValue(GenClassifier genClassifier)

getLocalClassifierIndex

public int getLocalClassifierIndex(GenClassifier genClassifier)

getPackageSimpleDependencies

public java.util.List getPackageSimpleDependencies()

getPackageInterDependencies

public java.util.List getPackageInterDependencies()

getPackageLoadInterDependencies

public java.util.List getPackageLoadInterDependencies()

getPackageBuildInterDependencies

public java.util.List getPackageBuildInterDependencies()

getPackageInitializationDependencies

public java.util.List getPackageInitializationDependencies()

getPackageInstanceVariable

public java.lang.String getPackageInstanceVariable(GenPackage genPackage)

getSubGenPackages

public java.util.List getSubGenPackages()
Returns a list of those nestedGenPackages for which hasClassifiers() is true.


getSuperGenPackage

public GenPackage getSuperGenPackage()
Returns the closest GenPackage-typed container for which hasClassifiers() is true, or null if there is none.


getRootGenPackage

public GenPackage getRootGenPackage()
Returns the top-most GenPackage-typed container for which hasClassifiers() is true, which may be this GenPackage, itself.


isLoadingInitialization

public boolean isLoadingInitialization()
Returns true if this is a root package that requires, or has a direct or indirect subpackage that requires, load initialization.


isLoadedInitialization

public boolean isLoadedInitialization()
Returns true if this package's root, which may be itself, requires, or has a subpackage that requires, load initialization.


isEcorePackage

public boolean isEcorePackage()

hasInterfaceImplConflict

public boolean hasInterfaceImplConflict()

hasJavaLangConflict

public boolean hasJavaLangConflict()

getJavaLangConflicts

public java.util.List getJavaLangConflicts()

hasClassifiers

public boolean hasClassifiers()

getAllSwitchGenClasses

public java.util.List getAllSwitchGenClasses()

getClassUniqueName

public java.lang.String getClassUniqueName(GenClass genClass)

getAllValidatorBaseGenPackages

public java.util.List getAllValidatorBaseGenPackages()

getValidatorPackageUniqueSafeName

public java.lang.String getValidatorPackageUniqueSafeName(GenPackage genPackage)

initialize

public void initialize(EPackage ePackage)

generateSchema

public void generateSchema()
Deprecated. Use GenBase.generateSchema(IProgressMonitor) instead. This method will be removed soon.


getProviderPackageName

public java.lang.String getProviderPackageName()

getPresentationPackageName

public java.lang.String getPresentationPackageName()

getItemProviderAdapterFactoryClassName

public java.lang.String getItemProviderAdapterFactoryClassName()

getQualifiedItemProviderAdapterFactoryClassName

public java.lang.String getQualifiedItemProviderAdapterFactoryClassName()

getImportedItemProviderAdapterFactoryClassName

public java.lang.String getImportedItemProviderAdapterFactoryClassName()

getEditorClassName

public java.lang.String getEditorClassName()

getQualifiedEditorClassName

public java.lang.String getQualifiedEditorClassName()

getImportedEditorClassName

public java.lang.String getImportedEditorClassName()

getModelWizardClassName

public java.lang.String getModelWizardClassName()

getQualifiedModelWizardClassName

public java.lang.String getQualifiedModelWizardClassName()

getImportedModelWizardClassName

public java.lang.String getImportedModelWizardClassName()

getActionBarContributorClassName

public java.lang.String getActionBarContributorClassName()

getQualifiedActionBarContributorClassName

public java.lang.String getQualifiedActionBarContributorClassName()

getImportedActionBarContributorClassName

public java.lang.String getImportedActionBarContributorClassName()

getAdapterFactoryDelegateName

public java.lang.String getAdapterFactoryDelegateName(GenPackage genDelegate)

getUncapAdapterFactoryDelegateName

public java.lang.String getUncapAdapterFactoryDelegateName(GenPackage genDelegate)

getEditPluginClassName

public java.lang.String getEditPluginClassName()

getQualifiedEditPluginClassName

public java.lang.String getQualifiedEditPluginClassName()

getImportedEditPluginClassName

public java.lang.String getImportedEditPluginClassName()

getEditorPluginClassName

public java.lang.String getEditorPluginClassName()

getQualifiedEditorPluginClassName

public java.lang.String getQualifiedEditorPluginClassName()

getImportedEditorPluginClassName

public java.lang.String getImportedEditorPluginClassName()

getAllGenFeatures

public java.util.List getAllGenFeatures()

getAdapterDelegatePackages

public java.util.List getAdapterDelegatePackages()

getAdapterDelegateSuperClasses

public java.util.List getAdapterDelegateSuperClasses()

reconcile

public boolean reconcile(GenPackage oldGenPackageVersion)

getAnnotationSources

public java.util.List getAnnotationSources()

getAnnotationSourceIdentifier

public java.lang.String getAnnotationSourceIdentifier(java.lang.String annotationSource)

getAllAnnotations

public java.util.List getAllAnnotations()

getAnnotatedModelElementAccessor

public java.lang.String getAnnotatedModelElementAccessor(EAnnotation eAnnotation)

getResourceClassName

public java.lang.String getResourceClassName()

getQualifiedResourceClassName

public java.lang.String getQualifiedResourceClassName()

getImportedResourceClassName

public java.lang.String getImportedResourceClassName()

getImportedResourceBaseClassName

public java.lang.String getImportedResourceBaseClassName()

getResourceFactoryClassName

public java.lang.String getResourceFactoryClassName()

getQualifiedResourceFactoryClassName

public java.lang.String getQualifiedResourceFactoryClassName()

getImportedResourceFactoryClassName

public java.lang.String getImportedResourceFactoryClassName()

getImportedResourceFactoryBaseClassName

public java.lang.String getImportedResourceFactoryBaseClassName()

hasXMLMap

public boolean hasXMLMap()

hasDocumentRoot

public boolean hasDocumentRoot()

hasExtendedMetaData

public boolean hasExtendedMetaData()

hasTargetNamespace

public boolean hasTargetNamespace()

hasConstraints

public boolean hasConstraints()

getSerializedPackageFilename

public java.lang.String getSerializedPackageFilename()

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