API changelog

This wiki page contains the API changelog for each Framesoc release introducing API changes.

v1.0.8

• Fixed a typo in TraceDBObject and SystemDBObject and thus the function openNewIstance() is now named openNewInstance().

v1.0.6

• The Framesoc configuration file contains a new variable trace_db_eid_indexing whose possible values are true and false. It enables or disables the automatic creation of a DB index on the EVENT_ID column in the EVENT_PARAM table. Default value is false.
• The Framesoc configuration variable trace_db_indexing is now called trace_db_ts_indexing, to make it clear that it is related to the timestamp. Default value is true.
• The Framesoc configuration variable max_view_instances has a special value for infinite view instances: -1. This is a constant of the Configuration class.
• A new boolean parameter show_default has been added to the fr.inria.soctrace.framesoc.ui.perspective.part extension point. It specifies if a Framesoc part must be opened in the default Framesoc perspective layout.
• Removed useless boolean parameter from TimestampFormat.setContext().

v1.0.2

• The Framesoc configuration file is no more in the user home. Its current path is <eclipse_installation_directory>/configuration/fr.inria.soctrace.lib.utils/soctrace.conf.
• The extension point fr.inria.soctrace.framesoc.core.tool has now an additional required id parameter. This id should be a string having the format this.is.my.tool.id. Each tool must have a unique id. Note: this id has nothing to do with the database ID column of TOOL table.
• IFramesocTool.launch() method now takes as input an instance of IFramesocToolInput. The prototype is now: void launch(IFramesocToolInput input).
• IFramesocTool.canLaunch() method now takes as input an instance of IFramesocToolInput. The prototype is now: ParameterCheckStatus canLaunch(IFramesocToolInput input).
• The Framesoc UI plugin now provides the fr.inria.soctrace.framesoc.ui.input.toolInput extension point, to allow Framesoc tools providing their own custom input composite. Such composite is responsible for providing the IFramesocToolInput object passed to IFramesocTool.launch() and IFramesocTool.canLaunch().
  • Importers not extending this extension point will be launched with a default input composite, providing a fr.inria.soctrace.framesoc.core.tools.model.FileInput.
  • Analysis tools not extending this extension point will be launched with a default input composite, providing an empty IFramesocToolInput.

v1.0.1

• IFramesocTool.canLaunch() method now returns a ParameterCheckStatus instead of a simple boolean. This object contains a boolean and a message for the user.
• addEventProducerColors() and addEventTypeColors() methods have been added to FramesocColorManager. These methods allow an importer to specify default values for colors unknown to the system.