com.togethersoft.openapi.sci
Interface SciModel

public interface SciModel

SciModel contains a set of starting-point methods for working with the
SCI model.

SCI model data is stored in special data containers -
packages.
A package can have other packages called subpackages.
The model can have several upper-level packages
called root packages.

The model can be obtained via SciModelAccess.getModel() method:

SciModel model = SciModelAccess.getModel(); 

SciPackageEnumeration roots = model.rootPackages(SciModelPart.MODEL);

while (roots.hasMoreElements()){

SciPackage nextRoot = roots.nextSciPackage();

myCoolMethodThatProcessesAPackage(nextRoot);

}

While working
with a package, the information can be extracted from it in files, classes, or subpackages:

SciPackageEnumeration roots = model.rootPackages(SciModelPart.MODEL);

while (roots.hasMoreElements()){

SciPackage nextRoot = roots.nextSciPackage();

SciClassEnumeration classes = nextRoot.classes();

while (classes.hasMoreElements()){

SciClass nextClass = classes.nextSciClass();

myCoolMethodThatProcessesAClass(nextClass);

}

}

The class SciUtil contains useful methods for finding a member by the
signature or by another method used as a template.

Author:

TogetherSoft

Since: Together 3.0

See Also: SciModelAccess, SciFactory, SciPatternManager, SciLanguageHelper

public SciClass findClass(String language, String qualifiedName)

Finds a class/interface by its qualified name.

Parameters:

language The string with the name of the source code language. The predefined
language names are in SciLanguage interface.

qualifiedName the string with the qualified name of the class/interface which needs to be found

Returns: a SciClass by its qualified name, or null if there is no such class

See Also:

SciLanguage

public SciElement findElement(String uniqueName)

Finds an element by its unique name.

Parameters:

uniqueName The string with the unique name of an element which needs to be found

Returns: an element by its unique name, or null if there is no such element

public SciFile findFile(String qualifiedName)

Finds a file by its qualified name.

Parameters:

qualifiedName the string with the qualified name of a file which needs to be found

Returns: a file by its qualified name, or null if there is no such file

public SciMember findMember(String language, String qualifiedName)

Finds a member by its qualified name.

Parameters:

language The string with the name of the source code language. The predefined
language names are in SciLanguage interface.

qualifiedName the string with the qualified name of a member which needs to be found

Returns: a member by its qualified name, or null if there is no such member

See Also:

SciLanguage

public SciPackage findPackage(String qualifiedName)

Deprecated.

Method findPackage(String, String) should be used instead.

See Also:

findPackage(java.lang.String,java.lang.String)

public SciPackage findPackage(String qualifiedName, String modelPart)

Finds a package by its qualified name.

Parameters:

qualifiedName the string with the qualified name of a package which needs to be found

modelPart The string with the kind of package to be found. Can be either SciModelPart.MODEL,
SciModelPart.IMPORT or SciModelPart.COMPONENT.

Returns: a package by its qualified name, or null if there is no such package

See Also:

SciModelPart

public SciPackage findPackageToPasteFile(String absoluteURL)

Tries to find an existing SciPackage where a new file with a given absolute URL
can be pasted according to project structure and "writeable for" properties of project roots.
This operation can be helpful when it is necessary to place some source element
(for example, a definition of a c++ operation) into the new file with a certain URL.
Steps to get it done could be as follows: create a new file with factory,
set its short name according to given URL, find target SciPackage by
call to this operation, paste file into package, paste source element to file.

Parameters:

absoluteURL The absolute URL of file to be created in the project

Returns: SciPackage object if an appropriate one is found, or null otherwise.

Since:

Together 5.0

See Also:

SciFile, SciPackage, SciFactory.newFile()

public void formatFile(SciFile sciFile)

Since:

Together 3.1

public SciPackage getDefaultRootPackage()

Deprecated.

Method rootPackages(String, String) should be used instead.

See Also:

rootPackages(java.lang.String)

public SciFactory getFactory(String language)

Returns SciFactory object for the specified language. This object allows to create
various types of model elements - classes, operations, attributes, and so on.

Parameters:

language The string with the name of the source code language. The predefined
language names are in SciLanguage interface.

Returns: SciFactory object for the specified language

See Also:

SciLanguage, SciFactory

public SciGenericFactory getGenericFactory(String language)

Returns SciGenericFactory object for the specified language.

Parameters:

language The string with the name of the source code language. The predefined
language names are in SciLanguage interface.

Returns: SciGenericFactory object for the specified language

See Also:

SciLanguage, SciGenericFactory

public SciLanguageHelper getLanguageHelper(String language)

Returns SciLanguageHelper object for the specified language. This object enables you to check
the validity of an identifier, and other language-dependent checks.

Parameters:

language The string with the name of the source code language. The predefined
language names are in SciLanguage interface.

Returns: SciLanguageHelper object for the specified language

See Also:

SciLanguage

public SciPatternManager getPatternManager()

Returns SciPatternManager object. This object provides
access to Together patterns.

Returns: SciPatternManager object

See Also:

SciPatternManager

public boolean isLanguageSupported(String language)

Checks whether a given language is supported in the current runtime configuration.
A particular language might not be supported because of configuration settings
(languages.config) or license restrictons.

Parameters:

language The string with the name of the source code language. The predefined
language names are in SciLanguage interface.

Returns: true if the language is supported, false otherwise

Since:

Together 6.0

See Also:

languages(), SciLanguage

public StringEnumeration languages()

Returns an enumeration of the string with the names of languages being used in this model.
The predefined language names are in SciLanguage interface.

Returns: an enumeration of the string with the names of languages being used in this model

See Also:

StringEnumeration, SciLanguage, isLanguageSupported(java.lang.String)

public SciPackageEnumeration rootPackages()

Deprecated.

Method rootPackages(String) should be used instead.

See Also:

rootPackages(java.lang.String)

public SciPackageEnumeration rootPackages(String modelPart)

Returns an enumeration of the root packages of the specific kind.

• rootPackages(SciModelPart.MODEL) returns an enumeration of the model's root packages.
  These are packages composing the model itself, and they contain its data (they are specified on the
  Project Paths tab in the Project Properties dialog (Advanced mode)).
  

  
  Normally you would use the method only with SciModelPart.MODEL parameter when working
  with the model.
  

  
  

• rootPackages(SciModelPart.IMPORT) returns an enumeration of the model's imported root packages.
  These are packages specified on the Search/Classpath tab in the Project Properties dialog (Advanced mode)).
  

  
  

• rootPackages(SciModelPart.COMPONENT) returns an enumeration of the components' root packages.
  Components can be added to the project by checking the Include Components checkbox in the Project Properties dialog.
  Note that components packages are considered imported packages as well and they will be included in
  the enumeration of packages returned by rootPackages(SciModelPart.IMPORT) call.
  

For example:

SciModel model = SciModelAccess.getModel();

SciPackageEnumeration roots = model.rootPackages(SciModelPart.MODEL);

while (roots.hasMoreElements()){

SciPackage nextRoot = roots.nextSciPackage();

myCoolMethodThatProcessesAPackage(nextRoot);

}

Parameters:

modelPart the string whose value can be either SciModelPart.MODEL,
SciModelPart.IMPORT, or SciModelPart.COMPONENT

Returns: an enumeration of the root packages

See Also:

SciModelPart, SciPackage