|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.eclipse.emf.converter.ModelConverter
org.eclipse.emf.exporter.ModelExporter
Nested Class Summary | |
static class |
ModelExporter.EPackageExportInfo
|
static class |
ModelExporter.ExportData
|
protected static class |
ModelExporter.GenPackagesTreeIterator
|
static class |
ModelExporter.ReferencedGenPackageExportInfo
|
Nested classes inherited from class org.eclipse.emf.converter.ModelConverter |
ModelConverter.EPackageConvertInfo, ModelConverter.ReferencedEPackageFilter, ModelConverter.ReferencedGenPackageConvertInfo |
Field Summary | |
protected URI |
directoryURI
|
protected Map |
ePackageToGenPackageMap
|
static String |
GENANNOTATION_KEY_DIRECTORY_URI
|
static String |
GENANNOTATION_SOURCE_PREFIX
|
static String |
GENANNOTATION_SOURCE_SELECTED_EPACKAGES
|
static String |
GENANNOTATION_SOURCE_SELECTED_REFERENCES
|
protected Map |
genBaseToDetailsMap
|
protected boolean |
saveEPackageArtifactURI
|
protected boolean |
saveExporter
|
Fields inherited from class org.eclipse.emf.converter.ModelConverter |
ePackages, ePackageToInfoMap, externalGenModelList, externalGenModelResourceSet, genModel, referencedEPackageFilter, referencedEPackageFilterToConvert, referencedGenPackages, referencedGenPackageToInfoMap |
Constructor Summary | |
ModelExporter()
|
Method Summary | |
protected void |
adjustGenModel()
|
protected boolean |
canConvert(EPackage ePackage)
Returns true if the EPackage can be converted. |
Diagnostic |
checkEPackageArtifactLocation(String location,
String packageName)
|
protected URI |
computeArtifactURI(String location)
Returns the artifact URI for a given artifact location. |
protected URI |
createEncodedURI(String location)
|
protected ModelConverter.EPackageConvertInfo |
createEPackageInfo(EPackage ePackage)
|
protected List |
createEPackagesList()
|
protected ModelConverter.ReferencedGenPackageConvertInfo |
createGenPackageConvertInfo(GenPackage genPackage)
|
protected ModelConverter.ReferencedEPackageFilter |
createReferencedEPackageFilterToConvert()
|
protected List |
createReferencedGenPackagesList()
|
void |
dispose()
|
protected String |
doCheckEPackageArtifactLocation(String location,
String packageName)
|
protected Diagnostic |
doExport(Monitor monitor,
ModelExporter.ExportData exportData)
Subclasses should overwrite this method, adding the code that performs the actions required to export the model. |
Diagnostic |
export(Monitor monitor)
Creates the ModelExporter.ExportData instance and delegates the export work to
the doExport(Monitor, ModelExporter.ExportData) method. |
List |
getArtifactURIs(GenPackage genPackage)
|
protected String |
getConverterGenAnnotationSource()
|
protected String |
getDefaultArtifactFileName(EPackage ePackage)
|
protected String |
getDefaultArtifactLocation(EPackage ePackage)
|
URI |
getDirectoryURI()
|
ModelExporter.EPackageExportInfo |
getEPackageExportInfo(EPackage ePackage)
|
protected Map |
getEPackageToGenPackageMap()
|
protected EMap |
getExporterGenAnnotationDetails(GenBase genBase)
Returns the GenBase object's GenAnnotation Details map
associated with this Model Exporter or ECollections.EMPTY_EMAP |
protected EMap |
getExporterNestedGenAnnotationDetails(GenBase genBase,
String nestedGenAnnotationSource)
|
protected List |
getExporterNestedGenAnnotations(GenBase genBase)
|
protected Map |
getGenBaseToGenAnnotationDetailsMap()
|
ModelExporter.ReferencedGenPackageExportInfo |
getReferencedGenPackageExportInfo(GenPackage genPackage)
|
boolean |
isSaveEPackageArtifactURI()
|
boolean |
isSaveExporter()
|
protected boolean |
isValidEPackage(GenPackage genPackage)
Returns whether the EPackage associated with the specified GenPackage should be added to the ePackage list. |
protected boolean |
isValidReferencedGenPackage(GenPackage genPackage)
Returns whether the specified GenPackage should be added to the referenced GenPackage list. |
void |
loadGenModel(URI uri)
|
protected void |
printExportData(ModelExporter.ExportData exportData)
|
void |
save()
Saves this exporters settings in the selected GenModel. |
protected boolean |
saveEPackageArtifactURI()
Saves the exported artifact URI as annotations on the respective GenPackage. |
protected boolean |
saveExporter()
Saves this exporter settings. |
void |
setDirectoryURI(String location)
|
void |
setDirectoryURI(URI directoryURI)
|
void |
setGenModel(GenModel genModel)
|
void |
setSaveEPackageArtifactURI(boolean saveEPackageArtifactURI)
|
void |
setSaveExporter(boolean saveExporter)
|
Diagnostic |
validateDirectoryURI(String uri)
|
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final String GENANNOTATION_SOURCE_PREFIX
public static final String GENANNOTATION_KEY_DIRECTORY_URI
public static final String GENANNOTATION_SOURCE_SELECTED_EPACKAGES
public static final String GENANNOTATION_SOURCE_SELECTED_REFERENCES
protected Map ePackageToGenPackageMap
protected URI directoryURI
protected Map genBaseToDetailsMap
protected boolean saveExporter
protected boolean saveEPackageArtifactURI
Constructor Detail |
public ModelExporter()
Method Detail |
public void dispose()
dispose
in class ModelConverter
protected String getConverterGenAnnotationSource()
getConverterGenAnnotationSource
in class ModelConverter
protected Map getEPackageToGenPackageMap()
protected Map getGenBaseToGenAnnotationDetailsMap()
protected EMap getExporterGenAnnotationDetails(GenBase genBase)
GenBase
object's GenAnnotation
Details map
associated with this Model Exporter or ECollections.EMPTY_EMAP
protected List getExporterNestedGenAnnotations(GenBase genBase)
protected EMap getExporterNestedGenAnnotationDetails(GenBase genBase, String nestedGenAnnotationSource)
public List getArtifactURIs(GenPackage genPackage)
public void setGenModel(GenModel genModel) throws DiagnosticException
DiagnosticException
protected void adjustGenModel()
protected String getDefaultArtifactLocation(EPackage ePackage)
protected boolean isValidEPackage(GenPackage genPackage)
protected boolean isValidReferencedGenPackage(GenPackage genPackage)
protected List createEPackagesList()
createEPackagesList
in class ModelConverter
protected List createReferencedGenPackagesList()
createReferencedGenPackagesList
in class ModelConverter
public void loadGenModel(URI uri) throws DiagnosticException
DiagnosticException
public ModelExporter.EPackageExportInfo getEPackageExportInfo(EPackage ePackage)
protected ModelConverter.EPackageConvertInfo createEPackageInfo(EPackage ePackage)
createEPackageInfo
in class ModelConverter
public ModelExporter.ReferencedGenPackageExportInfo getReferencedGenPackageExportInfo(GenPackage genPackage)
protected ModelConverter.ReferencedGenPackageConvertInfo createGenPackageConvertInfo(GenPackage genPackage)
createGenPackageConvertInfo
in class ModelConverter
protected ModelConverter.ReferencedEPackageFilter createReferencedEPackageFilterToConvert()
createReferencedEPackageFilterToConvert
in class ModelConverter
protected boolean canConvert(EPackage ePackage)
ModelConverter
canConvert
in class ModelConverter
public Diagnostic export(Monitor monitor) throws Exception
Creates the ModelExporter.ExportData
instance and delegates the export work to
the doExport(Monitor, ModelExporter.ExportData)
method.
The Diagnostic
returned by this method should be used to provide
the user some information regarding a successfull export. If the
export fails, an exception should be thrown.
monitor
-
Diagnostic
Exception
protected Diagnostic doExport(Monitor monitor, ModelExporter.ExportData exportData) throws Exception
Subclasses should overwrite this method, adding the code that performs the actions required to export the model.
The Diagnostic
returned by this method should be used to provide
the user some information regarding a successfull export. If the
export fails, an exception should be thrown.
monitor
-
Diagnostic
Exception
public Diagnostic checkEPackageArtifactLocation(String location, String packageName)
protected String doCheckEPackageArtifactLocation(String location, String packageName)
public URI getDirectoryURI()
public void setDirectoryURI(URI directoryURI)
public void setDirectoryURI(String location)
protected URI computeArtifactURI(String location)
protected URI createEncodedURI(String location)
public Diagnostic validateDirectoryURI(String uri)
public boolean isSaveEPackageArtifactURI()
public void setSaveEPackageArtifactURI(boolean saveEPackageArtifactURI)
public boolean isSaveExporter()
public void setSaveExporter(boolean saveExporter)
public void save() throws Exception
Exception
protected boolean saveExporter()
protected boolean saveEPackageArtifactURI()
protected String getDefaultArtifactFileName(EPackage ePackage)
protected void printExportData(ModelExporter.ExportData exportData)
|
Copyright 2001-2006 IBM Corporation and others. All Rights Reserved. |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |