de.interactive_instruments.ShapeChange.Model.EA
Class EADocument

java.lang.Object
  extended by de.interactive_instruments.ShapeChange.Model.ModelImpl
      extended by de.interactive_instruments.ShapeChange.Model.EA.EADocument
All Implemented Interfaces:
Model

public class EADocument
extends ModelImpl
implements Model


Field Summary
protected  String characterEncoding
          Character endcoding
protected  Set<String> excludedPackageNames
           
protected  int globalSequenceNumber
          Default sequence number for properties, if sequence numbering is selected and if no explicit number is given.
 Options options
           
protected  org.sparx.Repository repository
          EA repository object
 ShapeChangeResult result
           
static int STATUS_EADOCUMENT_ESTABLISHCLASSES
           
static int STATUS_EADOCUMENT_INITSTART
           
static int STATUS_EADOCUMENT_READCONSTARINTS
           
static int STATUS_EADOCUMENT_READMODEL
           
 
Fields inherited from class de.interactive_instruments.ShapeChange.Model.ModelImpl
allowedTags, gmlTags, jsonTags, postprocessed, shapeChangeTags
 
Constructor Summary
EADocument()
           
EADocument(ShapeChangeResult r, Options o, String repositoryFileName)
           
 
Method Summary
 String characterEncoding()
          Return character encoding of repository (Windows-1252)
 ClassInfo classById(String id)
          Return ClassInfo object given the id of a class
 ClassInfo classByName(String nam)
          Return ClassInfo object given the name of the class
 HashSet<ClassInfo> classes(PackageInfo pi)
          Return all ClassInfo objects contained in the given package and in sub- packages, which belong to the same targetNamespace as the given package.
 void executeCommonInitializationProcedure()
           
 void initialise(ShapeChangeResult r, Options o, String repositoryFileNameOrConnectionString)
          Connect to EA Repository without security information
 void initialise(ShapeChangeResult r, Options o, String repositoryFileNameOrConnectionString, String username, String password)
          Connect to EA Repository with security information
 Options options()
          Return options and configuration object.
 PackageInfo packageById(String id)
          Return PackageInfo object given the id of a package
 HashSet<PackageInfo> packages()
           
static String removeSpuriousEA75EntitiesFromStrings(String s)
          This auxiliary static method replaces some SGML entities which EA7.5 substitutes for a few symbols in some string fields, but does not bother to translate back in its automation interface.
 org.sparx.Repository repository()
          Return repository object (for applications using only the EA model option)
 ShapeChangeResult result()
          Return result object for error reporting.
 HashSet<PackageInfo> schemas(String name)
          Collect and return all PackageInfo objects tagged as being a schema.
 void shutdown()
          Shutdown EA model and quit EA
 int type()
          Return the model input type
 
Methods inherited from class de.interactive_instruments.ShapeChange.Model.ModelImpl
normalizeTaggedValue, postprocessAfterLoadingAndValidate, selectedSchemas
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface de.interactive_instruments.ShapeChange.Model.Model
postprocessAfterLoadingAndValidate, selectedSchemas
 

Field Detail

STATUS_EADOCUMENT_INITSTART

public static final int STATUS_EADOCUMENT_INITSTART
See Also:
Constant Field Values

STATUS_EADOCUMENT_READMODEL

public static final int STATUS_EADOCUMENT_READMODEL
See Also:
Constant Field Values

STATUS_EADOCUMENT_ESTABLISHCLASSES

public static final int STATUS_EADOCUMENT_ESTABLISHCLASSES
See Also:
Constant Field Values

STATUS_EADOCUMENT_READCONSTARINTS

public static final int STATUS_EADOCUMENT_READCONSTARINTS
See Also:
Constant Field Values

options

public Options options

result

public ShapeChangeResult result

repository

protected org.sparx.Repository repository
EA repository object


characterEncoding

protected final String characterEncoding
Character endcoding

See Also:
Constant Field Values

globalSequenceNumber

protected int globalSequenceNumber
Default sequence number for properties, if sequence numbering is selected and if no explicit number is given. Note: We are using MIN_VALUE/2 to have another disjunct space of still lower numbers available.


excludedPackageNames

protected Set<String> excludedPackageNames
Constructor Detail

EADocument

public EADocument()

EADocument

public EADocument(ShapeChangeResult r,
                  Options o,
                  String repositoryFileName)
           throws ShapeChangeAbortException
Throws:
ShapeChangeAbortException
Method Detail

options

public Options options()
Return options and configuration object.

Specified by:
options in interface Model

result

public ShapeChangeResult result()
Return result object for error reporting.

Specified by:
result in interface Model

initialise

public void initialise(ShapeChangeResult r,
                       Options o,
                       String repositoryFileNameOrConnectionString,
                       String username,
                       String password)
                throws ShapeChangeAbortException
Connect to EA Repository with security information

Specified by:
initialise in interface Model
Overrides:
initialise in class ModelImpl
Throws:
ShapeChangeAbortException

initialise

public void initialise(ShapeChangeResult r,
                       Options o,
                       String repositoryFileNameOrConnectionString)
                throws ShapeChangeAbortException
Connect to EA Repository without security information

Specified by:
initialise in interface Model
Throws:
ShapeChangeAbortException

executeCommonInitializationProcedure

public void executeCommonInitializationProcedure()
                                          throws ShapeChangeAbortException
Throws:
ShapeChangeAbortException

characterEncoding

public String characterEncoding()
Return character encoding of repository (Windows-1252)

Specified by:
characterEncoding in interface Model

classById

public ClassInfo classById(String id)
Return ClassInfo object given the id of a class

Specified by:
classById in interface Model

classByName

public ClassInfo classByName(String nam)
Return ClassInfo object given the name of the class

Specified by:
classByName in interface Model

classes

public HashSet<ClassInfo> classes(PackageInfo pi)
Description copied from interface: Model
Return all ClassInfo objects contained in the given package and in sub- packages, which belong to the same targetNamespace as the given package.

Specified by:
classes in interface Model
See Also:
Model.classes(de.interactive_instruments.ShapeChange.Model.PackageInfo)

packageById

public PackageInfo packageById(String id)
Return PackageInfo object given the id of a package

Specified by:
packageById in interface Model

schemas

public HashSet<PackageInfo> schemas(String name)
Collect and return all PackageInfo objects tagged as being a schema. If a name is given, only the package with the specified name will be considered.

Specified by:
schemas in interface Model

type

public int type()
Return the model input type

Specified by:
type in interface Model

shutdown

public void shutdown()
Shutdown EA model and quit EA

Specified by:
shutdown in interface Model

removeSpuriousEA75EntitiesFromStrings

public static String removeSpuriousEA75EntitiesFromStrings(String s)
This auxiliary static method replaces some SGML entities which EA7.5 substitutes for a few symbols in some string fields, but does not bother to translate back in its automation interface.


repository

public org.sparx.Repository repository()
Return repository object (for applications using only the EA model option)


packages

public HashSet<PackageInfo> packages()
Specified by:
packages in interface Model
Returns:
all PackageInfo objects contained in the model


Copyright © 2015. All rights reserved.