ssbm.file
Class ConfigXMLReader

java.lang.Object
  extended by ssbm.file.ConfigXMLReader

public class ConfigXMLReader
extends java.lang.Object

Questa classe espone i metodi necessari alla lettura di file XML di configurazione e all’estrazione del dizionario di proprietà che essi contengono.
Il dizionario di proprietà è un esemplare di Properties. Le proprietà estratte dovranno essere aggiunte alle proprietà di sistema per garantire il corretto funzionamento delle classi utilizzatrici.
Il nome della proprietà ha come prefisso ssbm seguito dai tag XML che fanno parte del percorso che, dall'elemento radice del document XML (escluso) conduce al testo che rappresenta il valore della proprietà; il separatore delle parti del nome delle proprietà è il punto (.)

Author:
Salvatore Piccione

Field Summary
protected static java.lang.String KEY_PARTS_SEPARATOR
          Il separatore delle parti che compongono il nome di una proprietà.
protected static java.lang.String KEY_PREFIX
          Il prefisso di tutti i nomi delle proprietà.
private  java.util.Properties properties
          Il dizionario di proprietà estratto dal documento XML.
private  org.jdom.Document xmlDocument
          Il documento XML contenente contenente il dizionario di proprietà.
 
Constructor Summary
ConfigXMLReader(org.jdom.Document xmlDocument)
          Imposta il documento XML dal quale estrarre le proprietà.
 
Method Summary
private  void extractProperties(org.jdom.Element root, java.lang.String name)
          Costruisce le proprietà analizzando un frammento XML in maniera ricorsiva.
 java.lang.String[] getPaths()
          Restituisce l'elenco dei percorsi di file presenti nel documento XML di configurazione.
 java.util.Properties getProperties()
          Restituisce il dizionario di proprietà estratto dal documento XML di configurazione.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

xmlDocument

private org.jdom.Document xmlDocument
Il documento XML contenente contenente il dizionario di proprietà.


properties

private java.util.Properties properties
Il dizionario di proprietà estratto dal documento XML.


KEY_PREFIX

protected static final java.lang.String KEY_PREFIX
Il prefisso di tutti i nomi delle proprietà.

See Also:
Constant Field Values

KEY_PARTS_SEPARATOR

protected static final java.lang.String KEY_PARTS_SEPARATOR
Il separatore delle parti che compongono il nome di una proprietà.

See Also:
Constant Field Values
Constructor Detail

ConfigXMLReader

public ConfigXMLReader(org.jdom.Document xmlDocument)
Imposta il documento XML dal quale estrarre le proprietà.

Parameters:
xmlDocument - il documento XML di riferimento.
Method Detail

extractProperties

private void extractProperties(org.jdom.Element root,
                               java.lang.String name)
Costruisce le proprietà analizzando un frammento XML in maniera ricorsiva.

Parameters:
root - l'elemento da esaminare: se l'elemento ha dei figli, la funzione è applicata a tutti i figli; se l'elemento non ha figli ma solo testo, si procede alla costruzione della proprietà.
name - il nome dell'elemento corrente preceduto dal nome di tutti gli ascendenti (esclusa la radice) separati tra loro dal carattere riportato in KEY_PARTS_SEPARATOR.

getProperties

public java.util.Properties getProperties()
Restituisce il dizionario di proprietà estratto dal documento XML di configurazione.

Returns:
l'istanza di Properties contenente le proprietà riportate nel file XML di configurazione.

getPaths

public java.lang.String[] getPaths()
Restituisce l'elenco dei percorsi di file presenti nel documento XML di configurazione.

Returns:
l'array di stringhe contenente i percorsi di file riportati nel documento XML di configurazione.