us.mitre.ShapeChange.Model.GSIP
Class GSIPDocument

java.lang.Object
  extended by de.interactive_instruments.ShapeChange.Model.ModelImpl
      extended by us.mitre.ShapeChange.Model.GSIP.GSIPDocument
All Implemented Interfaces:
Model

public class GSIPDocument
extends ModelImpl
implements Model


Field Summary
protected  String characterEncoding
          Character endcoding
protected  String enumLiteralSortType
           
protected  String kmlReferenceType
           
protected  Connection mdbConnection
           
 Options options
           
static String OPTIONS_GSIPDOCUMENT_ENUMLITERALORDERPARAMNAME
           
 ShapeChangeResult result
           
static int STATUS_GSIPDOCUMENT_ESTABLISHCLASSES
           
static int STATUS_GSIPDOCUMENT_INITSTART
           
static int STATUS_GSIPDOCUMENT_READCONSTRAINTS
           
static int STATUS_GSIPDOCUMENT_READMODEL
           
protected  boolean suppressAssociationNames
           
protected  boolean suppressAttributes
           
protected  boolean suppressDatatypes
           
 
Fields inherited from class de.interactive_instruments.ShapeChange.Model.ModelImpl
allowedTags, gmlTags, jsonTags, postprocessed, shapeChangeTags
 
Constructor Summary
GSIPDocument()
           
GSIPDocument(ShapeChangeResult r, Options o, String mdbFileName)
           
 
Method Summary
 String characterEncoding()
           
 ClassInfo classById(String id)
          Return ClassInfo object given the id of a class
 ClassInfo classByName(String nam)
          Return ClassInfo object given the name of a class
 HashSet<ClassInfo> classes(PackageInfo pi)
          Return all ClassInfo objects contained in the given package and in sub- packages, which do not belong to an app schema different to the one of the given package.
protected static String getDescriptionString(String name, String definition, String description)
           
protected static String getDocumentationString(String name, String definition, String description, String note)
           
 void initialise(ShapeChangeResult r, Options o, String mdbFileName)
           
 String normalizeTaggedValue(String tag)
           
 Options options()
          Return options and configuration object.
 PackageInfo packageById(String id)
           
 HashSet<PackageInfo> packages()
           
 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()
           
 int type()
           
 
Methods inherited from class de.interactive_instruments.ShapeChange.Model.ModelImpl
initialise, 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
initialise, postprocessAfterLoadingAndValidate, selectedSchemas
 

Field Detail

STATUS_GSIPDOCUMENT_INITSTART

public static final int STATUS_GSIPDOCUMENT_INITSTART
See Also:
Constant Field Values

STATUS_GSIPDOCUMENT_READMODEL

public static final int STATUS_GSIPDOCUMENT_READMODEL
See Also:
Constant Field Values

STATUS_GSIPDOCUMENT_ESTABLISHCLASSES

public static final int STATUS_GSIPDOCUMENT_ESTABLISHCLASSES
See Also:
Constant Field Values

STATUS_GSIPDOCUMENT_READCONSTRAINTS

public static final int STATUS_GSIPDOCUMENT_READCONSTRAINTS
See Also:
Constant Field Values

OPTIONS_GSIPDOCUMENT_ENUMLITERALORDERPARAMNAME

public static final String OPTIONS_GSIPDOCUMENT_ENUMLITERALORDERPARAMNAME
See Also:
Constant Field Values

options

public Options options

result

public ShapeChangeResult result

characterEncoding

protected final String characterEncoding
Character endcoding

See Also:
Constant Field Values

enumLiteralSortType

protected String enumLiteralSortType

suppressAssociationNames

protected boolean suppressAssociationNames

suppressAttributes

protected boolean suppressAttributes

suppressDatatypes

protected boolean suppressDatatypes

kmlReferenceType

protected String kmlReferenceType

mdbConnection

protected Connection mdbConnection
Constructor Detail

GSIPDocument

public GSIPDocument()

GSIPDocument

public GSIPDocument(ShapeChangeResult r,
                    Options o,
                    String mdbFileName)
             throws ShapeChangeAbortException
Throws:
ShapeChangeAbortException
Method Detail

normalizeTaggedValue

public String normalizeTaggedValue(String tag)
Overrides:
normalizeTaggedValue in class ModelImpl

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 mdbFileName)
                throws ShapeChangeAbortException
Specified by:
initialise in interface Model
Throws:
ShapeChangeAbortException

characterEncoding

public String characterEncoding()
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 a class

Specified by:
classByName in interface Model

classes

public HashSet<ClassInfo> classes(PackageInfo pi)
Return all ClassInfo objects contained in the given package and in sub- packages, which do not belong to an app schema different to the one of the given package.

Specified by:
classes in interface Model

packageById

public PackageInfo packageById(String id)
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. In this case, we store the schemas in their own HashMap for convenience anyway. ALSO, we do an extra check to see if the schema really is an Application Schema in the sense that ShapeChange is expecting (isAppSchema() == true). GSIP uses the additional "<>" stereotype, which designates "schema-level" packages that nevertheless are not actual Application Schemas. Not doing this check means that all the "schemas" get returned.

Specified by:
schemas in interface Model

shutdown

public void shutdown()
Specified by:
shutdown in interface Model

type

public int type()
Specified by:
type in interface Model

getDescriptionString

protected static String getDescriptionString(String name,
                                             String definition,
                                             String description)

getDocumentationString

protected static String getDocumentationString(String name,
                                               String definition,
                                               String description,
                                               String note)

packages

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


Copyright © 2015. All rights reserved.