edu.cmu.sei.osate.workspace
Interface IAadlProject

All Superinterfaces:
IAadlElement

public interface IAadlProject
extends IAadlElement

Represent an AADL project. This object mirrors an Eclipse project.

This interface provides methods for finding files in projects.

This interface is not intended to be implemented by clients.


Field Summary
 
Fields inherited from interface edu.cmu.sei.osate.workspace.IAadlElement
AADL_PACKAGE, AADL_PROPERTYSET, AADL_SPECIFICATION
 
Method Summary
 void cleanAllAADLTextFiles(org.eclipse.core.runtime.IProgressMonitor monitor)
          clean all AADL Text files
 void cleanAllDeclarativeModelFiles(org.eclipse.core.runtime.IProgressMonitor monitor)
          clean all declarative AADL (XML) files
 void deleteAllInstanceModelFiles(org.eclipse.core.runtime.IProgressMonitor monitor)
          delete all instance files
 org.eclipse.core.resources.IFile findAadlModelFile(java.lang.String name)
          Look up a package or property set XML model by name in all projects in the workspace.
 org.eclipse.core.resources.IFile findAadlSourceFile(java.lang.String name)
          Look up a package or property set by name in this project
 IAadlElement findElement(org.eclipse.core.runtime.IPath element)
           
 org.eclipse.core.resources.IFile getAadlFile(org.eclipse.core.resources.IFile aaxlFile)
          get the aadl file for the aaxl file, or null
 org.eclipse.core.runtime.IPath getAadlPath(org.eclipse.core.resources.IFile file)
          return the path to the AADL text file that corresponds to the specified aaxl model file
 org.eclipse.core.resources.IFile getAaxlFile(org.eclipse.core.resources.IFile aadlFile)
          get the output (model) file for the specified file, or null
 org.eclipse.core.runtime.IPath getAaxlPath(org.eclipse.core.resources.IFile aadlFile)
          Create the path of the XML ouput file for a given AADL source file in this project.
 org.eclipse.emf.common.util.EList<org.eclipse.core.resources.IFile> getAllInstanceModelFiles(org.eclipse.core.runtime.IProgressMonitor monitor)
          get all instance model files
 org.eclipse.emf.common.util.EList<org.eclipse.core.resources.IFile> getAllModelFiles()
          Get all the model files in the project, both declarative and instance.
 org.eclipse.emf.common.util.EList<org.eclipse.core.resources.IFile> getAllSourceFiles()
          get all source files
 org.eclipse.core.resources.IFolder getComplementFolder(org.eclipse.core.resources.IFolder folder)
          return the Aadl folder corresponding to the aaxl folder
 org.eclipse.core.resources.IProject getProject()
           
 org.eclipse.core.resources.IFile getRecentAaxlFile(org.eclipse.core.resources.IFile file)
          return recent aaxl file. return null if there are syntax errors, or the aaxl filedoes not exist or is out of date
 
Methods inherited from interface edu.cmu.sei.osate.workspace.IAadlElement
getAadlProject, getParent
 

Method Detail

findElement

IAadlElement findElement(org.eclipse.core.runtime.IPath element)

getProject

org.eclipse.core.resources.IProject getProject()

findAadlSourceFile

org.eclipse.core.resources.IFile findAadlSourceFile(java.lang.String name)
Look up a package or property set by name in this project

Parameters:
name - the name of the package to find
Returns:
the file resource for the source, an .aadl file, or null if the file cannot be found.

findAadlModelFile

org.eclipse.core.resources.IFile findAadlModelFile(java.lang.String name)
Look up a package or property set XML model by name in all projects in the workspace. The lookup uses the projects' aadlpaths.

Parameters:
name - the name of the package to find
Returns:
the file resource for the model, an .aaxl file, or null if the file cannot be found.

getAaxlPath

org.eclipse.core.runtime.IPath getAaxlPath(org.eclipse.core.resources.IFile aadlFile)
Create the path of the XML ouput file for a given AADL source file in this project.

Parameters:
aadlFile - the AADL source file
Returns:
the path of the corresponding model file

getAadlPath

org.eclipse.core.runtime.IPath getAadlPath(org.eclipse.core.resources.IFile file)
return the path to the AADL text file that corresponds to the specified aaxl model file

Parameters:
file -
Returns:
IPath path

getRecentAaxlFile

org.eclipse.core.resources.IFile getRecentAaxlFile(org.eclipse.core.resources.IFile file)
return recent aaxl file. return null if there are syntax errors, or the aaxl filedoes not exist or is out of date

Parameters:
file - IFile aadl text file
Returns:
IFile aaxl file

cleanAllDeclarativeModelFiles

void cleanAllDeclarativeModelFiles(org.eclipse.core.runtime.IProgressMonitor monitor)
clean all declarative AADL (XML) files


cleanAllAADLTextFiles

void cleanAllAADLTextFiles(org.eclipse.core.runtime.IProgressMonitor monitor)
clean all AADL Text files


getAaxlFile

org.eclipse.core.resources.IFile getAaxlFile(org.eclipse.core.resources.IFile aadlFile)
get the output (model) file for the specified file, or null

Parameters:
aadlFile -
Returns:
model file or null

getAadlFile

org.eclipse.core.resources.IFile getAadlFile(org.eclipse.core.resources.IFile aaxlFile)
get the aadl file for the aaxl file, or null

Parameters:
aaxlFile - XML aadl file
Returns:
model file or null

getComplementFolder

org.eclipse.core.resources.IFolder getComplementFolder(org.eclipse.core.resources.IFolder folder)
return the Aadl folder corresponding to the aaxl folder

Parameters:
folder -

getAllSourceFiles

org.eclipse.emf.common.util.EList<org.eclipse.core.resources.IFile> getAllSourceFiles()
get all source files


deleteAllInstanceModelFiles

void deleteAllInstanceModelFiles(org.eclipse.core.runtime.IProgressMonitor monitor)
delete all instance files


getAllInstanceModelFiles

org.eclipse.emf.common.util.EList<org.eclipse.core.resources.IFile> getAllInstanceModelFiles(org.eclipse.core.runtime.IProgressMonitor monitor)
get all instance model files


getAllModelFiles

org.eclipse.emf.common.util.EList<org.eclipse.core.resources.IFile> getAllModelFiles()
Get all the model files in the project, both declarative and instance.