com.groiss.reporting.data
Class Schema

java.lang.Object
  com.groiss.reporting.data.Schema

public class Schema
extends Object

the Schema includes all Information of the DOM parsed XML Schema with comfortable accessmehtods a schema includes

• entities
A Entity is a table on the database which contains the data
• relations
describing the relations between the entities, to make the right join decision
• mappings
are used to translate database values to the natural language

Constructor Summary

Schema()


Schema(String id, String name, String addForms)


Schema(String id, String name, String addForms, int furtherHops, TimeModel defaultTm, String unit)


Schema(String id, String name, String addForms, String furtherHops, String defaultTm, String unit)
Public Constructor

Method Summary

void	addEntity(String key, Entity e) adding an entity to the schema
void	addMapping(String key, Map<String,String> map) adds a mapping to the schema
void	addRelation(com.groiss.reporting.data.impl.Relation r)
void	buildRelationGraph()
boolean	getAddForms()
org.jdom.Element	getAsDomElement()
TimeModel	getDefaultTimemodel()
String	getDefaultUnit()
int	getEdgesCount()
HashMap<String,Entity>	getEntities()
Entity	getEntity(String key) returns an entity to a specified key
int	getFurtherHops()
String	getID()
static Schema	getInstance()
Map<String,String>	getMap(String key)
String	getMappedString(String mapId, String key) returns a maped string to a given key
Map<String,Map<String,String>>	getMappings()
String	getName()
List<List<com.groiss.reporting.data.impl.Relation>>	getPossiblePaths(Entity start, Entity end)
List<List<com.groiss.reporting.data.impl.Relation>>	getPossiblePaths(Entity start, Entity end, int maxHopsMoreThanSP)
List<List<com.groiss.reporting.data.impl.Relation>>	getPossiblePaths(String start, String end)
List<List<com.groiss.reporting.data.impl.Relation>>	getPossiblePaths(String start, String end, int maxHopsMoreThanSP)
com.groiss.reporting.data.impl.RelationGraph	getRelationGraph()
List<com.groiss.reporting.data.impl.Relation>	getRelations(Entity start)
List<com.groiss.reporting.data.impl.Relation>	getTempRelations()
void	setDefaultTimemodel(TimeModel defaultTimemodel)
void	setDefaultUnit(String defaultUnit)
void	setFurtherHops(int furtherHops)

Methods inherited from class java.lang.Object

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

Constructor Detail

Schema

public Schema()

Schema

public Schema(String id,
              String name,
              String addForms,
              String furtherHops,
              String defaultTm,
              String unit)
       throws NumberFormatException,
              InstantiationException,
              IllegalAccessException,
              ClassNotFoundException

Public Constructor

Parameters:

id - the id of the schema

name - the name of the schema

addForms - "true" if forms should be added to the schema automatically

defaultTm - classname of reporting default timemodel

furtherHops - indicates the exitcondition of searching joins.

unit - the default unit of timeintervals

Throws:

ClassNotFoundException - timemodel class was not found

IllegalAccessException - imtemodel class was not instantiatable

InstantiationException - imtemodel class was not instantiatable

NumberFormatException - furtherHops was not parseable

Schema

public Schema(String id,
              String name,
              String addForms,
              int furtherHops,
              TimeModel defaultTm,
              String unit)

Schema

public Schema(String id,
              String name,
              String addForms)

Method Detail

getAddForms

public boolean getAddForms()

Returns:

addForms

getID

public String getID()

Returns:

the id of the schema

getName

public String getName()

Returns:

the name of the schema

addEntity

public void addEntity(String key,
                      Entity e)

adding an entity to the schema

Parameters:

key - the id of the entity

e - the entity

getEntity

public Entity getEntity(String key)

returns an entity to a specified key

Parameters:

key - the specified key

Returns:

the entity, if found... else null

getEntities

public HashMap<String,Entity> getEntities()

Returns:

all Entities attached to this Schema

addRelation

public void addRelation(com.groiss.reporting.data.impl.Relation r)

buildRelationGraph

public void buildRelationGraph()

getRelations

public List<com.groiss.reporting.data.impl.Relation> getRelations(Entity start)

getEdgesCount

public int getEdgesCount()

addMapping

public void addMapping(String key,
                       Map<String,String> map)

adds a mapping to the schema

Parameters:

key - - the mapping id

map - - the mapping

getMap

public Map<String,String> getMap(String key)

Parameters:

key - - the mapping id

Returns:

- the mapping

getMappedString

public String getMappedString(String mapId,
                              String key)

returns a maped string to a given key

Parameters:

mapId - - the mapping to use

key - - the key

Returns:

- the string (which is checked for I18N) returns null if no mapping is found or if the mpping doesnt contain the mapping

getRelationGraph

public com.groiss.reporting.data.impl.RelationGraph getRelationGraph()

getPossiblePaths

public List<List<com.groiss.reporting.data.impl.Relation>> getPossiblePaths(Entity start,
                                                                            Entity end)

getPossiblePaths

public List<List<com.groiss.reporting.data.impl.Relation>> getPossiblePaths(String start,
                                                                            String end)

getPossiblePaths

public List<List<com.groiss.reporting.data.impl.Relation>> getPossiblePaths(Entity start,
                                                                            Entity end,
                                                                            int maxHopsMoreThanSP)

getPossiblePaths

public List<List<com.groiss.reporting.data.impl.Relation>> getPossiblePaths(String start,
                                                                            String end,
                                                                            int maxHopsMoreThanSP)

getDefaultTimemodel

public TimeModel getDefaultTimemodel()

getDefaultUnit

public String getDefaultUnit()

getFurtherHops

public int getFurtherHops()

getAsDomElement

public org.jdom.Element getAsDomElement()

setDefaultTimemodel

public void setDefaultTimemodel(TimeModel defaultTimemodel)

setDefaultUnit

public void setDefaultUnit(String defaultUnit)

setFurtherHops

public void setFurtherHops(int furtherHops)

getTempRelations

public List<com.groiss.reporting.data.impl.Relation> getTempRelations()

getMappings

public Map<String,Map<String,String>> getMappings()

getInstance

public static Schema getInstance()

Returns:

schema instance