JaRMoS  1.1
Java Reduced Model Simulations
 All Classes Namespaces Files Functions Variables Enumerator Groups Pages
jarmos.app.io.AssetModelManager Class Reference

Class to load models from application assets. More...

Inheritance diagram for jarmos.app.io.AssetModelManager:
jarmos.io.AModelManager

Public Member Functions

 AssetModelManager (Context c)
 Creates a new ModelManager. More...
 
ClassLoader getClassLoader ()
 
boolean modelFileExists (String filename)
 
URI getModelURI ()
 Returns an URI for the current model location/directory. More...
 
- Public Member Functions inherited from jarmos.io.AModelManager
 AModelManager ()
 Constructs a new ModelManager and a private DocumentBuilder and SchemaFactory. More...
 
void addMessageHandler (IMessageHandler h)
 
Object loadModelClass (String name) throws ModelManagerException
 Loads a class available in the precompiled classes associated with the current model. More...
 
BufferedReader getBufReader (String filename) throws IOException
 
ClassLoader getClassLoader ()
 This method yields access to any specialized class loaders in subclasses. More...
 
final InputStream getInStream (String filename) throws IOException
 Returns an InputStream instance streaming the contents of the file given by filename. More...
 
MathObjectReader getMathObjReader ()
 Use this method in order to get a MathObjectReader instance fitted for the current selected model. More...
 
List< ModelDescriptorgetModelDescriptors () throws ModelManagerException
 Scans all directories given by getFolderList() for valid models and returns a list of model descriptors for each valid model. More...
 
List< ModelDescriptorgetModelDescriptors (IProgressReporter pr) throws ModelManagerException
 Scans all directories given by getFolderList() for valid models and returns a list of model descriptors for each valid model. More...
 
String getModelDir ()
 
FieldDescriptor[] getModelFieldTypes ()
 
ModelType getModelType ()
 Returns the model type as given in the model.xml attribute "type" of the "model" tag. More...
 
String getModelXMLAttribute (String attrib_name)
 Returns the attribute value of any attributes of the "model" tag in the model.xml file. More...
 
String getModelXMLAttribute (String attrib_name, String tagname)
 Returns the attribute value of any attributes of the tag given by tagname in the model.xml file. More...
 
String getModelXMLTagValue (String tagname)
 Works as the overload with default value, but returns null if no matchin element is found. More...
 
String getModelXMLTagValue (String tagname, String default_value)
 Returns the text content of a tag inside the model.xml file. More...
 
String getModelPackageStr ()
 Returns the package of any java source files associated with this model. More...
 
Parameters getParameters ()
 Reads the parameters from the model XML file and returns a Parameters object. More...
 
boolean isValidModelDir (String dir)
 Checks if a model.xml file exists in the specified directory and performs xsd-validation. More...
 
void removeMessageHandler (IMessageHandler h)
 
void useModel (String location) throws ModelManagerException
 Sets the specified source as current model path. More...
 
boolean xmlTagExists (String tagname)
 Checks if a specified tag exists inside the current models model.xml file. More...
 

Protected Member Functions

InputStream getInStreamImpl (String filename) throws IOException
 Template method. More...
 
String[] getFolderList () throws IOException
 Returns the list of all models directories available at the ModelManagers source location. More...
 
String getLoadingMessage ()
 A short message that writes "loading SD models" dependent on the actual instance. More...
 
- Protected Member Functions inherited from jarmos.io.AModelManager
void sendMessage (String msg)
 

Additional Inherited Members

- Static Public Attributes inherited from jarmos.io.AModelManager
static final String CLASSES_JARFILE = "classes.jar"
 The name of the jar file inside a models directory containing .class files in java bytecode. More...
 
static final String info_filename = "site_info.html"
 The model's info html file name (imported from rbappmit, might change later) More...
 

Detailed Description

Class to load models from application assets.

This class has been taken from the original rbAppMIT package and modified to fit into the current JaRMoS framework.

Author
Daniel Wirtz
Date
2013-08-07

Definition at line 22 of file AssetModelManager.java.

Constructor & Destructor Documentation

jarmos.app.io.AssetModelManager.AssetModelManager ( Context  c)

Creates a new ModelManager.

Parameters
cThe context (i.e. current Activity)

Definition at line 34 of file AssetModelManager.java.

Member Function Documentation

ClassLoader jarmos.app.io.AssetModelManager.getClassLoader ( )
String [] jarmos.app.io.AssetModelManager.getFolderList ( ) throws IOException
protectedvirtual

Returns the list of all models directories available at the ModelManagers source location.

At this stage, no validity checks have to be performed regarding if a returned folder actually contains a valid model.

Returns
Exceptions
IOException

Implements jarmos.io.AModelManager.

Definition at line 63 of file AssetModelManager.java.

InputStream jarmos.app.io.AssetModelManager.getInStreamImpl ( String  filename) throws IOException
protectedvirtual

Template method.

Implementations of this method must locate the given file inside the current model directory and return an input stream pointing to it.

Parameters
filenameThe model file to return a stream for
Returns
An InputStream pointing to the resource
Exceptions
IOException

Implements jarmos.io.AModelManager.

Definition at line 58 of file AssetModelManager.java.

String jarmos.app.io.AssetModelManager.getLoadingMessage ( )
protectedvirtual

A short message that writes "loading SD models" dependent on the actual instance.

Returns

Implements jarmos.io.AModelManager.

Definition at line 90 of file AssetModelManager.java.

URI jarmos.app.io.AssetModelManager.getModelURI ( )
virtual

Returns an URI for the current model location/directory.

Returns

Implements jarmos.io.AModelManager.

Definition at line 85 of file AssetModelManager.java.

boolean jarmos.app.io.AssetModelManager.modelFileExists ( String  filename)
virtual
See Also
jarmos.io.AModelManager::modelFileExists(java.lang.String)

Implements jarmos.io.AModelManager.

Definition at line 71 of file AssetModelManager.java.


The documentation for this class was generated from the following file: