edu::tum::cs::srldb::datadict::DataDictionary Class Reference

Inheritance diagram for edu::tum::cs::srldb::datadict::DataDictionary:
Inheritance graph
[legend]

List of all members.

Classes

class  BLNStructure
class  DomainData

Public Member Functions

void addAttribute (DDAttribute attr) throws DDException
void addObject (DDObject obj) throws DDException
void addRelation (DDRelation rel) throws DDException
void check () throws DDException
void checkLink (Link link) throws DDException, Exception
void checkObject (Object obj) throws DDException
void cleanUp ()
BLNStructure createBasicBLNStructure ()
 DataDictionary ()
DDAttribute getAttribute (String name) throws DDException
Collection< DDAttributegetAttributes ()
Domain getDomain (String name)
DDObject getObject (String name) throws DDException
Collection< DDObjectgetObjects ()
DDRelation getRelation (String name)
Collection< DDRelationgetRelations ()
void onCommitLink (Link l) throws DDException
void onCommitObject (Object o) throws DDException
void outputAttributeList (PrintStream out)
void outputAttributeLists (PrintStream out)
String toString ()
void writeBasicBLOGModel (PrintStream out)
void writeBasicMLN (PrintStream out)

Protected Member Functions

void addAttributes (DDItem item) throws DDException
void checkItemAttributes (Item item, DDItem ddItem) throws DDException

Protected Attributes

HashMap< String, DDAttributeattributes
HashMap< String, Domain > domains
HashMap< String, DDObjectobjects
HashMap< String, DDRelationrelations

Static Private Attributes

static final long serialVersionUID = 1L

Detailed Description

Definition at line 21 of file DataDictionary.java.


Constructor & Destructor Documentation

edu::tum::cs::srldb::datadict::DataDictionary::DataDictionary (  )  [inline]

Definition at line 32 of file DataDictionary.java.


Member Function Documentation

void edu::tum::cs::srldb::datadict::DataDictionary::addAttribute ( DDAttribute  attr  )  throws DDException [inline]

adds the given attribute to the data dictionary. This function should not be called unless an attribute is added to an item (object or link) after the item was added to the data dictionary, as all of an item's attributes are added automatically when addObject or addRelation is called.

Parameters:
attr 
Exceptions:
DDException if an attribute with the same name was already in the data dictionary

Definition at line 63 of file DataDictionary.java.

void edu::tum::cs::srldb::datadict::DataDictionary::addAttributes ( DDItem  item  )  throws DDException [inline, protected]

adds the attributes of a given item (object or relation) to the global list of attributes

Parameters:
item 
Exceptions:
DDException 

Definition at line 49 of file DataDictionary.java.

void edu::tum::cs::srldb::datadict::DataDictionary::addObject ( DDObject  obj  )  throws DDException [inline]

Definition at line 39 of file DataDictionary.java.

void edu::tum::cs::srldb::datadict::DataDictionary::addRelation ( DDRelation  rel  )  throws DDException [inline]

Definition at line 71 of file DataDictionary.java.

void edu::tum::cs::srldb::datadict::DataDictionary::check (  )  throws DDException [inline]

Checks the data dictionary for overlapping domains. Each value must be unique (i.e. it can only be contained in a single domain). Should a value be contained in two (or more) domains, all references to the second domain are replaced by the first. It is assumed that the first domain can be substituted - no merging takes place. Moreover, it is ensured that attribute names do not coincide with link names - as both are eventually used as predicate symbols in the context of MLNs.

Definition at line 124 of file DataDictionary.java.

void edu::tum::cs::srldb::datadict::DataDictionary::checkItemAttributes ( Item  item,
DDItem  ddItem 
) throws DDException [inline, protected]

checks compatibility of an item's attributes with the corresponding data dictionary item

Parameters:
item 
ddItem 
Exceptions:
DDException 

Definition at line 246 of file DataDictionary.java.

void edu::tum::cs::srldb::datadict::DataDictionary::checkLink ( Link  link  )  throws DDException, Exception [inline]

Definition at line 209 of file DataDictionary.java.

void edu::tum::cs::srldb::datadict::DataDictionary::checkObject ( Object  obj  )  throws DDException [inline]

Definition at line 202 of file DataDictionary.java.

void edu::tum::cs::srldb::datadict::DataDictionary::cleanUp (  )  [inline]

cleans up stale domain references

Definition at line 460 of file DataDictionary.java.

BLNStructure edu::tum::cs::srldb::datadict::DataDictionary::createBasicBLNStructure (  )  [inline]

Definition at line 418 of file DataDictionary.java.

DDAttribute edu::tum::cs::srldb::datadict::DataDictionary::getAttribute ( String  name  )  throws DDException [inline]

Definition at line 89 of file DataDictionary.java.

Collection<DDAttribute> edu::tum::cs::srldb::datadict::DataDictionary::getAttributes (  )  [inline]

Definition at line 77 of file DataDictionary.java.

Domain edu::tum::cs::srldb::datadict::DataDictionary::getDomain ( String  name  )  [inline]

Definition at line 93 of file DataDictionary.java.

DDObject edu::tum::cs::srldb::datadict::DataDictionary::getObject ( String  name  )  throws DDException [inline]

Definition at line 81 of file DataDictionary.java.

Collection<DDObject> edu::tum::cs::srldb::datadict::DataDictionary::getObjects (  )  [inline]

Definition at line 97 of file DataDictionary.java.

DDRelation edu::tum::cs::srldb::datadict::DataDictionary::getRelation ( String  name  )  [inline]

Definition at line 85 of file DataDictionary.java.

Collection<DDRelation> edu::tum::cs::srldb::datadict::DataDictionary::getRelations (  )  [inline]

Definition at line 101 of file DataDictionary.java.

void edu::tum::cs::srldb::datadict::DataDictionary::onCommitLink ( Link  l  )  throws DDException [inline]
void edu::tum::cs::srldb::datadict::DataDictionary::onCommitObject ( Object  o  )  throws DDException [inline]
void edu::tum::cs::srldb::datadict::DataDictionary::outputAttributeList ( PrintStream  out  )  [inline]

outputs a comma-separated list of all attribute names, regardless of the item to which the attributes belong

Parameters:
out the stream to write to

Definition at line 191 of file DataDictionary.java.

void edu::tum::cs::srldb::datadict::DataDictionary::outputAttributeLists ( PrintStream  out  )  [inline]

outputs an attribute list for each type of object and relation

Parameters:
out the stream to write to

Definition at line 178 of file DataDictionary.java.

String edu::tum::cs::srldb::datadict::DataDictionary::toString (  )  [inline]

Definition at line 444 of file DataDictionary.java.

void edu::tum::cs::srldb::datadict::DataDictionary::writeBasicBLOGModel ( PrintStream  out  )  [inline]

outputs the basic BLOG model for this data dictionary, which contains domain definitions and predicate declarations

Parameters:
out the stream to write to

Definition at line 338 of file DataDictionary.java.

void edu::tum::cs::srldb::datadict::DataDictionary::writeBasicMLN ( PrintStream  out  )  [inline]

outputs the basic MLN for this data dictionary, which contains domain definitions and predicate declarations

Parameters:
out the stream to write to

Definition at line 269 of file DataDictionary.java.


Member Data Documentation

Definition at line 26 of file DataDictionary.java.

HashMap<String, Domain> edu::tum::cs::srldb::datadict::DataDictionary::domains [protected]

!!! this map is not guaranteed to contain all relevant entries (is not certain to be in sync)

Definition at line 30 of file DataDictionary.java.

Definition at line 24 of file DataDictionary.java.

Definition at line 25 of file DataDictionary.java.

Reimplemented in edu::tum::cs::srldb::datadict::AutomaticDataDictionary.

Definition at line 23 of file DataDictionary.java.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Enumerations


srldb
Author(s): Dominik Jain, Stefan Waldherr, Moritz Tenorth
autogenerated on Fri Jan 11 09:58:46 2013