jadex.bridge.modelinfo

Class ModelInfo

java.lang.Object

jadex.bridge.modelinfo.Startable

jadex.bridge.modelinfo.ModelInfo

All Implemented Interfaces:

IModelInfo

public class ModelInfo
extends Startable
implements IModelInfo

Public model information that is provided as result from component factories when a model is loaded.

Constructor Summary

Constructors

Constructor and Description
ModelInfo() Create a new model info.
ModelInfo(String name, String packagename, String description, IErrorReport report, IArgument[] arguments, IArgument[] results, boolean startable, String filename, Map<String,Object> properties, ClassLoader classloader, RequiredServiceInfo[] requiredservices, ProvidedServiceInfo[] providedservices, ConfigurationInfo[] configurations, SubcomponentTypeInfo[] subcomponents, String[] imports, IResourceIdentifier rid) Create a new model info.

Method Summary

Methods

Modifier and Type	Method and Description
void	addArgument(IArgument argument) Add an argument.
void	addConfiguration(ConfigurationInfo configuration) Add a configuration.
void	addExtensiontype(Object extension) Add a extension type.
void	addImport(String imp) Add an import statement.
void	addProperty(String name, Object value) Add a property.
void	addProperty(UnparsedExpression unexp) Add a property.
void	addProvidedService(ProvidedServiceInfo providedservice) Add a provided service.
void	addRequiredService(RequiredServiceInfo requiredservice) Add a required service.
void	addResult(IArgument result) Add a result.
void	addSubcomponentType(SubcomponentTypeInfo subcomponent) Add a subcomponent type.
boolean	checkName() Check if the specified name matches the file name.
boolean	checkPackage() Check if the specified package matches the file name.
String[]	getAllImports() Get the imports including the package.
IArgument	getArgument(String name) Get an argument per name.
IArgument[]	getArguments() Get the arguments.
Boolean	getAutoShutdown(String configname) Get the autoshutdown flag.
ConfigurationInfo	getConfiguration(String name) Get a configuration.
String[]	getConfigurationNames() Get the configurations.
ConfigurationInfo[]	getConfigurations() Get the configurations.
Boolean	getDaemon(String configname) Get the daemon flag.
Object[]	getExtensionTypes() Get the extension names.
String	getFilename() Get the filename.
String	getFullName() Get the full model name (package.name)
String[]	getImports() Get the imports.
Boolean	getMaster(String configname) Get the master flag.
IMonitoringService.PublishEventLevel	getMonitoring(String configname) Get the monitoring flag.
String	getName() Get the name.
List<NFPropertyInfo>	getNFProperties() Get the nfproperties.
String	getPackage() Get the package name.
Map<String,Object>	getProperties() Get the properties.
Object	getProperty(String name, ClassLoader cl) Get a parsed property.
ProvidedServiceInfo[]	getProvidedServices() Get the provided services.
IErrorReport	getReport() Get the report.
RequiredServiceInfo	getRequiredService(String name) Get the required service.
RequiredServiceInfo[]	getRequiredServices() Get the required services.
IResourceIdentifier	getResourceIdentifier() Return the resource identifier.
IArgument	getResult(String name) Get a result per name.
IArgument[]	getResults() Get the results.
SubcomponentTypeInfo[]	getSubcomponentTypes() Get the subcomponent names.
Boolean	getSuspend(String configname) Get the suspend flag.
Boolean	getSynchronous(String configname) Get the synchronous flag.
String	getType() Get the model type.
boolean	isStartable() Is the model startable.
void	removeProvidedService(ProvidedServiceInfo providedservice) Remove a provided service.
void	removeRequiredService(RequiredServiceInfo requiredservice) Remove a required service.
void	setArguments(IArgument[] arguments) Set the arguments.
void	setConfigurations(ConfigurationInfo[] configurations) Set the configurations.
void	setExtensiontypes(Object[] extensions) Set the extension types.
void	setFilename(String filename) Set the filename.
void	setImports(String[] imports) Set the imports.
void	setName(String name) Set the name.
void	setNFProperties(List<NFPropertyInfo> nfproperties) Set the nfproperties.
void	setPackage(String packagename) Set the packagename.
void	setProperties(Map<String,Object> properties) Set the properties.
void	setProvidedServices(ProvidedServiceInfo[] providedservices) Set the provided services.
void	setReport(IErrorReport report) Set the report.
void	setRequiredServices(RequiredServiceInfo[] requiredservices) Set the required services.
void	setResourceIdentifier(IResourceIdentifier rid) Set the resource identifier.
void	setResults(IArgument[] results) Set the results.
void	setStartable(boolean startable) Set the startable.
void	setSubcomponentTypes(SubcomponentTypeInfo[] subcomponents) Set the subcomponent types.
void	setType(String type) Set the component type.

Methods inherited from class jadex.bridge.modelinfo.Startable

getAutoShutdown, getDaemon, getDescription, getMaster, getMonitoring, getSuspend, getSynchronous, setAutoShutdown, setDaemon, setDescription, setMaster, setMonitoring, setSuspend, setSynchronous

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface jadex.bridge.modelinfo.IModelInfo

getDescription

Constructor Detail

ModelInfo

public ModelInfo()

Create a new model info.

ModelInfo

public ModelInfo(String name,
         String packagename,
         String description,
         IErrorReport report,
         IArgument[] arguments,
         IArgument[] results,
         boolean startable,
         String filename,
         Map<String,Object> properties,
         ClassLoader classloader,
         RequiredServiceInfo[] requiredservices,
         ProvidedServiceInfo[] providedservices,
         ConfigurationInfo[] configurations,
         SubcomponentTypeInfo[] subcomponents,
         String[] imports,
         IResourceIdentifier rid)

Create a new model info.

Method Detail

getName

public String getName()

Get the name.

Specified by:

getName in interface IModelInfo

Returns:

The name.

getPackage

public String getPackage()

Get the package name.

Specified by:

getPackage in interface IModelInfo

Returns:

The package name.

getFullName

public String getFullName()

Get the full model name (package.name)

Specified by:

getFullName in interface IModelInfo

Returns:

The full name.

getImports

public String[] getImports()

Get the imports.

Specified by:

getImports in interface IModelInfo

Returns:

The imports.

getAllImports

public String[] getAllImports()

Get the imports including the package.

Specified by:

getAllImports in interface IModelInfo

Returns:

The imports.

addImport

public void addImport(String imp)

Add an import statement.

getReport

public IErrorReport getReport()

Get the report.

Specified by:

getReport in interface IModelInfo

Returns:

The report.

getConfigurationNames

public String[] getConfigurationNames()

Get the configurations.

Specified by:

getConfigurationNames in interface IModelInfo

Returns:

The configuration.

getConfigurations

public ConfigurationInfo[] getConfigurations()

Get the configurations.

Specified by:

getConfigurations in interface IModelInfo

Returns:

The configuration.

getConfiguration

public ConfigurationInfo getConfiguration(String name)

Get a configuration.

Specified by:

getConfiguration in interface IModelInfo

Returns:

The configuration.

getArguments

public IArgument[] getArguments()

Get the arguments.

Specified by:

getArguments in interface IModelInfo

Returns:

The arguments.

getArgument

public IArgument getArgument(String name)

Get an argument per name.

Specified by:

getArgument in interface IModelInfo

Parameters:

name - The name.

Returns:

The argument.

getResults

public IArgument[] getResults()

Get the results.

Specified by:

getResults in interface IModelInfo

Returns:

The results.

getResult

public IArgument getResult(String name)

Get a result per name.

Specified by:

getResult in interface IModelInfo

Parameters:

name - The name.

Returns:

The result.

isStartable

public boolean isStartable()

Is the model startable.

Specified by:

isStartable in interface IModelInfo

Returns:

True, if startable.

getType

public String getType()

Get the model type.

Specified by:

getType in interface IModelInfo

Returns:

The model type (kernel specific).

getFilename

public String getFilename()

Get the filename.

Specified by:

getFilename in interface IModelInfo

Returns:

The filename.

getProperties

public Map<String,Object> getProperties()

Get the properties. Arbitrary properties that can e.g. be used to define model-specific settings to configure tools.

Specified by:

getProperties in interface IModelInfo

Returns:

The properties.

getProperty

public Object getProperty(String name,
                 ClassLoader cl)

Get a parsed property. Unlike raw properties, which may be parsed or unparsed, this method always returns parsed property values.

Specified by:

getProperty in interface IModelInfo

Parameters:

name - The property name.

Returns:

The property value or null if property not defined.

getNFProperties

public List<NFPropertyInfo> getNFProperties()

Get the nfproperties.

Specified by:

getNFProperties in interface IModelInfo

Returns:

The nfproperties.

setNFProperties

public void setNFProperties(List<NFPropertyInfo> nfproperties)

Set the nfproperties.

Parameters:

nfproperties - The nfproperties to set.

getResourceIdentifier

public IResourceIdentifier getResourceIdentifier()

Return the resource identifier.

Specified by:

getResourceIdentifier in interface IModelInfo

Returns:

The resource identifier.

setName

public void setName(String name)

Set the name.

Parameters:

name - The name to set.

setPackage

public void setPackage(String packagename)

Set the packagename.

Parameters:

packagename - The packagename to set.

setReport

public void setReport(IErrorReport report)

Set the report.

Parameters:

report - The report to set.

setImports

public void setImports(String[] imports)

Set the imports.

Parameters:

imports - The imports to set.

setConfigurations

public void setConfigurations(ConfigurationInfo[] configurations)

Set the configurations.

Parameters:

configurations - The configurations to set.

addConfiguration

public void addConfiguration(ConfigurationInfo configuration)

Add a configuration.

Parameters:

configuration - The configuration.

setArguments

public void setArguments(IArgument[] arguments)

Set the arguments.

Parameters:

arguments - The arguments to set.

addArgument

public void addArgument(IArgument argument)

Add an argument.

Parameters:

argument - The argument.

setResults

public void setResults(IArgument[] results)

Set the results.

Parameters:

results - The results to set.

addResult

public void addResult(IArgument result)

Add a result.

Parameters:

result - The result.

setStartable

public void setStartable(boolean startable)

Set the startable.

Parameters:

startable - The startable to set.

setFilename

public void setFilename(String filename)

Set the filename.

Parameters:

filename - The filename to set.

setType

public void setType(String type)

Set the component type.

Parameters:

type - The component type to set.

setProperties

public void setProperties(Map<String,Object> properties)

Set the properties.

Parameters:

properties - The properties to set.

addProperty

public void addProperty(String name,
               Object value)

Add a property.

addProperty

public void addProperty(UnparsedExpression unexp)

Add a property.

getRequiredServices

public RequiredServiceInfo[] getRequiredServices()

Get the required services.

Specified by:

getRequiredServices in interface IModelInfo

Returns:

The required services.

setResourceIdentifier

public void setResourceIdentifier(IResourceIdentifier rid)

Set the resource identifier.

Parameters:

rid - The resource identifier to set.

setRequiredServices

public void setRequiredServices(RequiredServiceInfo[] requiredservices)

Set the required services.

Parameters:

required - services The required services to set.

getRequiredService

public RequiredServiceInfo getRequiredService(String name)

Get the required service.

Specified by:

getRequiredService in interface IModelInfo

Returns:

The required service.

addRequiredService

public void addRequiredService(RequiredServiceInfo requiredservice)

Add a required service.

Parameters:

requiredservice - The required service.

removeRequiredService

public void removeRequiredService(RequiredServiceInfo requiredservice)

Remove a required service.

Parameters:

requiredservice - The required service.

getProvidedServices

public ProvidedServiceInfo[] getProvidedServices()

Get the provided services.

Specified by:

getProvidedServices in interface IModelInfo

Returns:

The provided services.

setProvidedServices

public void setProvidedServices(ProvidedServiceInfo[] providedservices)

Set the provided services.

Parameters:

provided - services The provided services to set.

addProvidedService

public void addProvidedService(ProvidedServiceInfo providedservice)

Add a provided service.

Parameters:

providedservice - The provided service.

removeProvidedService

public void removeProvidedService(ProvidedServiceInfo providedservice)

Remove a provided service.

Parameters:

providedservice - The provided service.

getMaster

public Boolean getMaster(String configname)

Get the master flag.

Specified by:

getMaster in interface IModelInfo

Parameters:

configname - The configname.

Returns:

The master flag value.

getDaemon

public Boolean getDaemon(String configname)

Get the daemon flag.

Specified by:

getDaemon in interface IModelInfo

Parameters:

configname - The configname.

Returns:

The daemon flag value.

getAutoShutdown

public Boolean getAutoShutdown(String configname)

Get the autoshutdown flag.

Specified by:

getAutoShutdown in interface IModelInfo

Parameters:

configname - The configname.

Returns:

The autoshutdown flag value.

getSuspend

public Boolean getSuspend(String configname)

Get the suspend flag.

Specified by:

getSuspend in interface IModelInfo

Parameters:

configname - The configname.

Returns:

The suspend flag value.

getMonitoring

public IMonitoringService.PublishEventLevel getMonitoring(String configname)

Get the monitoring flag.

Specified by:

getMonitoring in interface IModelInfo

Parameters:

configname - The configname.

Returns:

The monitoring flag value.

getSynchronous

public Boolean getSynchronous(String configname)

Get the synchronous flag.

Specified by:

getSynchronous in interface IModelInfo

Parameters:

synchronous - The synchronous.

Returns:

The synchronous flag value.

getSubcomponentTypes

public SubcomponentTypeInfo[] getSubcomponentTypes()

Get the subcomponent names.

Specified by:

getSubcomponentTypes in interface IModelInfo

setSubcomponentTypes

public void setSubcomponentTypes(SubcomponentTypeInfo[] subcomponents)

Set the subcomponent types.

addSubcomponentType

public void addSubcomponentType(SubcomponentTypeInfo subcomponent)

Add a subcomponent type.

Parameters:

subcomponent - The subcomponent type.

getExtensionTypes

public Object[] getExtensionTypes()

Get the extension names.

Specified by:

getExtensionTypes in interface IModelInfo

Returns:

An array of extension declarations as specified in the extensions section of the component model. The concrete object type depends on the type of the extension (e.g. EnvSupport vs. AGR).

setExtensiontypes

public void setExtensiontypes(Object[] extensions)

Set the extension types.

addExtensiontype

public void addExtensiontype(Object extension)

Add a extension type.

Parameters:

extension - The extension type.

checkName

public boolean checkName()

Check if the specified name matches the file name.

checkPackage

public boolean checkPackage()

Check if the specified package matches the file name.