context.dtd

context.dtd


<panckoucke>

The root element of a context configuration xml file

<panckoucke>'s children
Name  Cardinality  Required
storeManager1No
modelProvider1No
notificationRegistry1No
gestaltRegistry1No
representationRegistry1No
rendererMNo
abstractorMNo
loadMapMNo

the only valid value is the actual panckoucke version



<gestalt> Child of gestaltRegistry

registeres a new Gestalt with the given id in the GestaltRegistry

<gestalt>'s attributes
Name  Value  Required
idIDYes

This element has no children


id Attribute of gestalt

the id of this gestalt (you need to implement a custom Abstractor to male use of custom gestalten)

Possible values : ID - required : Yes


<gestaltRegistry> Child of panckoucke,abstractor

defines the GestaltRegistry implementation used

<gestaltRegistry>'s children
Name  Cardinality  Required
gestaltMNo
      
<gestaltRegistry>'s attributes
Name  Value  Required
clazzCDATAYes

clazz Attribute of gestaltRegistry

fixed to org.tm4j.panckoucke.api.model.AMGestaltRegistry, this will be changed later

Possible values : CDATA - required : Yes


<member> Child of abstractor,renderer,representation

can be used to set a member of a class (in other word, this works as a JavaBean Property Set Mechanism)

Example :

	
  <member name="color" value="red"/>
	would be interpreted as setColor("red");
	<member name="modelFactory" type="org.tm4j.panckoucke.impl.model.AModelFactoryImpl"/> 
	would be interpreted as setModelFactory(new AModelFactoryImpl());

<member>'s attributes
Name  Value  Required
nameCDATAYes
typeCDATANo
valueCDATANo

This element has no children


name Attribute of member

the name of the field or member

Possible values : CDATA - required : Yes


type Attribute of member

the full class name of the member or fields type

Possible values : CDATA - required : No


value Attribute of member

the value of the member or field

Possible values : CDATA - required : No


<modelProvider> Child of panckoucke

defines the ModelProvider implementation used
the standart implementation is org.tm4j.panckoucke.impl.model.ModelProviderImpl

<modelProvider>'s attributes
Name  Value  Required
clazzCDATAYes

This element has no children


clazz Attribute of modelProvider

a class implementing the org.tm4j.panckoucke.api.model.ModelProvider Interface

Possible values : CDATA - required : Yes


<notificationRegistry> Child of panckoucke

defines the NotificationRegistry implementation used

<notificationRegistry>'s attributes
Name  Value  Required
clazzCDATAYes

This element has no children


clazz Attribute of notificationRegistry

a class implementing the org.tm4j.panckoucke.api.notification.NotificationRegistry Interface
the standart implementation is org.tm4j.panckoucke.impl.notification.NotificationRegistryImpl

Possible values : CDATA - required : Yes


<storeManager> Child of panckoucke

Defines the StoreManager used in this context

<storeManager>'s children
Name  Cardinality  Required
providerMNo
      
<storeManager>'s attributes
Name  Value  Required
clazzCDATAYes

clazz Attribute of storeManager

a class implementing the org.tm4j.panckoucke.api.store.StoreManager Interface
the standart implementation is org.tm4j.panckoucke.impl.store.StoreManagerImpl

Possible values : CDATA - required : Yes


<provider> Child of storeManager

creates a TopicMapProvider and puts it in the StoreManager calls the createProvider method of the specified ProviderFactory using a Properties object created after the properties attribute

<provider>'s children
Name  Cardinality  Required
propertyMNo
      
<provider>'s attributes
Name  Value  Required
factoryCDATAYes
propertiesCDATAYes

factory Attribute of provider

the full class name of the TM4J TopicMap Provider Factory

Possible values : CDATA - required : Yes


properties Attribute of provider

the properties attribute defines the source for the basic properties
valid are empty, system or a file name where
- system: the system Properties will be used as basic properties
- empty: a new Properties object will be created
- anything else: will be interpreted as the name of a properties file. These file will be loaded into a new Properties object

Possible values : CDATA - required : Yes


<property> Child of provider

used to add a property to the properties object of the sourrounding TopicMapProvider
this is equivalent to the java call [some properties object].setProperty("name", "value");

<property>'s attributes
Name  Value  Required
nameCDATAYes
valueCDATAYes

This element has no children


name Attribute of property

the name of the property

Possible values : CDATA - required : Yes


value Attribute of property

the value of the property

Possible values : CDATA - required : Yes


<representationRegistry> Child of panckoucke,renderer

defines the Representation Registry implementation

<representationRegistry>'s children
Name  Cardinality  Required
representationMNo
      
<representationRegistry>'s attributes
Name  Value  Required
clazzCDATAYes

clazz Attribute of representationRegistry

a class implementing the org.tm4j.panckoucke.core.render.rep.IRepresentationRegistry Interface
the standart implementation is org.tm4j.panckoucke.core.render.rep.RepresentationRegistryImpl

Possible values : CDATA - required : Yes


<representation> Child of representationRegistry

used to registre new Representations in the RepresentationRegistry

<representation>'s children
Name  Cardinality  Required
memberMNo
      
<representation>'s attributes
Name  Value  Required
clazzCDATAYes
idIDYes

id Attribute of representation

the id which can be used to retrieve this representation from the registry

Possible values : ID - required : Yes


clazz Attribute of representation

the full name of a class implementing the Representation interface

Possible values : CDATA - required : Yes


<renderer> Child of panckoucke

defines a Renderer

<renderer>'s children
Name  Cardinality  Required
representationRegistry1No
memberMNo
      
<renderer>'s attributes
Name  Value  Required
clazzCDATAYes
idIDYes

id Attribute of renderer

the id which can be used to retrieve this renderer from the context

Possible values : ID - required : Yes


clazz Attribute of renderer

a class implementing the Renderer interface

Possible values : CDATA - required : Yes


<abstractor> Child of panckoucke

defines an abstractor

Example : <abstractor id="compact" clazz="org.tm4j.panckoucke.impl.abstraction.compact.CompactAbstractor"/>

<abstractor>'s children
Name  Cardinality  Required
gestaltRegistry1No
memberMNo
      
<abstractor>'s attributes
Name  Value  Required
clazzCDATAYes
idIDYes

id Attribute of abstractor

the id which can be used to retrieve this abstactor from the context

Possible values : ID - required : Yes


clazz Attribute of abstractor

a class implementing the Abstractor interface

Possible values : CDATA - required : Yes


<loadMap> Child of panckoucke

this tag can be used to load TopicMaps into the standart TopicMapProvider of the StoreManager
the standart Provider depends on the implementation of the StoreManager
(usually this tag will be used to load a TopicMap from an XTM or LTM file into an InMemoryProvider
using the ThreadBased TopicMap loading of panckoucke)

<loadMap>'s attributes
Name  Value  Required
notationCDATANo
sourceCDATAYes

This element has no children


source Attribute of loadMap

the location of the TopicMap file

Possible values : CDATA - required : Yes


notation Attribute of loadMap

OPTIONAL xtm for XTM files and LTM for ltm files

Possible values : CDATA - required : No