arom.kr.factory
Interface AromSystem

Format Summary
standard	This is a textual description of AROM Knowledge Representation. The output is human readable, it is possible to save/store a complete KnowledgeBase, or only some components of a base.
instances	This is also a textual description of AROM Knowledge Representation which allow only AMInstances saving. The other difference with standard format (which could also save only instances) is in the Reader. Indeed, this version is more faster than the standard reader for reading great number of instances.
records	This format allows to save and restore only instances in a binary format. The binary format permits to assume that no value has been changed by user so the reading can be done without any verifications. This format is faster than both standard and instances formats.

Format Detail

Standard

• Actually readContent (AMClass container, InputStream reader, TestResult result), readContent (AMAssociation container, InputStream reader, TestResult result) and readFacetModifier (Class facetType, InputStream reader, TestResult result) methods are not implemented. An UnsupportedOperationException will be thrown if one of these is called.
  
• Not all syntax errors will thrown an exception. Error which generates only warnings
  :
  • Variable type is not valid. (Unknown in TypeSystem)
  • Invalid variable name
  • Error during variable creation
  • Invalid slot redefinition
  • Exception thrown during Instance creation
  
  Error which generate Exceptions.
  
  • Duplicate structre name
  • Duplicate instance name
  • Unknown Super-Structure
  • Unknown instance owner
  • Unknown role type (No AROM Class defined)
  • Exception thrown during Structure creation
  
  
• write(KnowledgeBase entity, OutputStream output) Writes all KnowledgeBase contents (Structures and instances) to outputStream in txta format
  
• write(Structure entity, OutputStream output) Writes the specified Structure intention (only its description not its instances) to outputStream in txta format
  

Instances

• createKB(InputStream input, TestResult result), readContent (AMClass container, InputStream reader, TestResult result), readContent (AMAssociation container, InputStream reader, TestResult result) and readFacetModifier (Class facetType, InputStream reader, TestResult result) have no definition in this format. Only instances description are supported and could be added to an existing KnowledgeBase. Use standard format for KnowledgeBase or Model creation. An InvalidFormatException will be thrown if one of these is called.
  
• readContent(KnowledgeBase entity, InputStream input, TestResult result) The description read from InputStream should only contains instances definitions.
  Warning only errors:
  • Unknown variable
  • Incorrect variable value
  
  Errors which generates Exceptions:
  • Unknown instance owner
  • Exception thrown during Instance creation (duplicate name, tuple link error, ...)
  
  
• write(KnowledgeBase entity, OutputStream output) Writes all KnowledgeBase instances to outputStream in txta format
  
• write(Structure entity, OutputStream output) not defined in this reader. An InvalidFormatException willbe thrown if called.
  

Records

• All methods, but one, of KBReader are invalid in this format, an InvalidFormatException will be thrown if one of these is called. Only readContent(KnowledgeBase kb, InputStream input, TestResult result) is implemented.
  
• readContent(KnowledgeBase entity, InputStream input, TestResult result) The description read from InputStream should only contains instances definitions in record (binary) format.
  Errors which generates Exceptions:
  • Unknown instance owner
  • Incorrect variable value (Object value for variables)
  • Exception thrown during Instance creation (duplicate name, tuple link error, ...)
  
  
• write(KnowledgeBase entity, OutputStream output) writes all KnowledgeBase instances to outputStream in records format
  
• write(Structure entity, OutputStream output) writes specified Structure proper instances to outputStream in records format.