it.eng.spago.base
Class SourceBean

java.lang.Object
  extended byit.eng.spago.base.AbstractXMLObject
      extended byit.eng.spago.base.SourceBean
All Implemented Interfaces:
CloneableObject, java.io.Serializable, XMLObject
Direct Known Subclasses:
ConfigSingleton

public class SourceBean
extends AbstractXMLObject
implements CloneableObject, java.io.Serializable

La classe SourceBean implementa un contenitore di oggetti. Ogni oggetto memorizzato nel contenitore è associato ad una chiave che ne consente il recupero. Più oggetti possono essere memorizzati con la stessa chiave. Al contenitore è associato un nome.

Il contenitore è in grado di ritornare una sua rappresentazione XML e di costruirsi a partire da uno stream XML (File, String, ...).

Un esempio d'uso è il seguente:

 SourceBean inner = new SourceBean("inner");
 inner.setAttribute("param1", 1);
 inner.setAttribute("param2", "value2");
 SourceBean outer = new SourceBean("outer");
 outer.setAttribute("param3", "value3");
 outer.setAttribute(inner);
 

e la relativa rappresentazione XML è:

 <OUTER param3="value3">
     <INNER param1="1" param2="value2">
     </INNER>
 </OUTER>
 

Per recuperare il/i valori di un attributo il servizio da invocare è del tipo:

 String value2 = (String)outer.getAttribute("inner.param2");
 

La chiave di un attributo può sempre essere espressa con una dot-notation:

 String key = "key1.key2.key3";
 

See Also:
SourceBeanAttribute, Serialized Form

Constructor Summary
SourceBean(SourceBean sourceBean)
          Costruisce un SourceBean copia di sourceBean.
SourceBean(java.lang.String name)
          Costruisce un SourceBean vuoto con nome name.
 
Method Summary
 void clearBean()
          Elimina tutto il conenuto del SourceBean.
 void clearBean(java.lang.String key)
          Elimina tutto il contenuto del SourceBean corrispondente all'attributo di chiave key.
 CloneableObject cloneObject()
          Ritorna un CloneableObject copia non profonda dell'oggetto stesso.
 boolean containsAttribute(java.lang.String key)
          Ritorna true se l'oggetto sourceBean contiene almento un elemento con chiave key.
 void delAttribute(java.lang.String key)
          Elimina tutti i valori dell'attributo con chiave key.
 void delCharacters()
          Elimina il testo contenuto nel SourceBean.
 void delCharacters(java.lang.String key)
          Elimina il testo contenuto nel SourceBean corrispondente all'attributo di chiave key.
 void delContainedAttributes()
          Elimina tutti gli attributi contenuti nel SourceBean.
 void delContainedAttributes(java.lang.String key)
          Elimina tutti gli attributi contenuti nel SourceBean corrispondente all'attributo di chiave key.
static SourceBean fromXMLFile(java.lang.String xmlSourceBean)
          Ritorna il SourceBean ottenuto dal parsing del file xmlSourceBean.
static SourceBean fromXMLStream(org.xml.sax.InputSource stream)
          Ritorna il SourceBean ottenuto dal parsing dell'InputSource stream.
static SourceBean fromXMLString(java.lang.String xmlSourceBean)
          Ritorna il SourceBean ottenuto dal parsing della stringa xmlSourceBean.
 java.lang.Object getAttribute(java.lang.String key)
          Ritorna tutti i valori dell'attributo con chiave key.
 java.util.List getAttributeAsList(java.lang.String key)
          Ritorna tutti i valori dell'attributo con chiave key.
 java.lang.Object getAttributeItem(java.lang.String key)
          Ritorna tutti gli oggetti di tipo SourceBeanAttribute il cui campo chiave vale key.
 java.lang.String getCharacters()
          Ritorna il testo contenuto nel SourceBean.
 java.lang.String getCharacters(java.lang.String key)
          Ritorna il testo contenuto nel SourceBean corrispondente all'attributo di chiave key.
 java.util.List getContainedAttributes()
          Ritorna tutti gli oggetti di tipo SourceBeanAttribute contenuti.
 java.util.List getContainedAttributes(java.lang.String key)
          Ritorna tutti gli oggetti di tipo SourceBeanAttribute contenuti nel SourceBean corrispondente all'attributo di chiave key.
 java.util.List getContainedSourceBeanAttributes()
          Ritorna gli oggetti di tipo SourceBeanAttribute contenuti il cui valore associato è di tipo SourceBean.
 java.util.List getContainedSourceBeanAttributes(java.lang.String key)
          Ritorna gli oggetti di tipo SourceBeanAttribute contenuti nel SourceBean corrispondente all'attributo di chiave key ed il cui valore associato è di tipo SourceBean.
 java.lang.Object getFilteredSourceBeanAttribute(java.lang.String key, java.lang.String paramName, java.lang.String paramValue)
          Ritorna tutti i valori dell'attributo con chiave key che sono di tipo SourceBean e contengono un attributo single-value con chiave paramName e valore paramValue.
 java.util.List getFilteredSourceBeanAttributeAsList(java.lang.String key, java.lang.String paramName, java.lang.String paramValue)
          Ritorna un List contenente tutti i valori dell'attributo con chiave key che sono di tipo SourceBean e contengono un attributo single-value con chiave paramName e valore paramValue.
 java.util.Vector getFullKeyPaths(java.lang.String key)
          Ritorna il vettore di chiavi in dot-notation degli attributi a cui è associata la chiave key.
 java.lang.String getName()
          Ritorna il nome del SourceBean.
 void setAttribute(SourceBean value)
          Aggiunge al SourceBean un nuovo attributo il cui valore è un SourceBean.
 void setAttribute(java.lang.String key, java.lang.Object value)
          Aggiunge al SourceBean un nuovo attributo con chiave key e valore value.
 void setBean(SourceBean sourceBean)
          Copia tutto il contenuto del parametro SourceBean nel proprio stato.
 void setBean(java.lang.String key, SourceBean sourceBean)
          Copia il contenuto del parametro SourceBean nel proprio stato a partire dall'attributo con chiave key.
 void setCharacters(java.lang.String characters)
          Sostituisce il testo contenuto con quello del parametro characters.
 void setCharacters(java.lang.String key, java.lang.String characters)
          Sostituisce il testo contenuto nel SourceBean corrispondente all'attributo di chiave key con quello del parametro characters.
 void setContainedAttributes(java.util.List attributes)
          Sostituisce tutti gli oggetti di tipo SourceBeanAttribute contenuti con quelli del vettore attributes.
 void setContainedAttributes(java.lang.String key, java.util.List attributes)
          Sostituisce tutti gli oggetti di tipo SourceBeanAttribute contenuti nel SourceBean corrispondente all'attributo di chiave key con quelli del vettore attributes.
 org.w3c.dom.Element toElement(org.w3c.dom.Document document)
          Ritorna un oggetto di tipo Element che verrą utilizzato nella rappresentazione in XML dell'oggetto.
 java.lang.String toString()
           
 void updAttribute(SourceBean value)
           
 void updAttribute(java.lang.String key, java.lang.Object value)
          Sostituisce il valore dell'attributo con chiave key con il nuovo valore value.
 void updContainedAttributes(java.util.List attributes)
           
 void updContainedAttributes(java.lang.String key, java.util.ArrayList attributes)
           
 
Methods inherited from class it.eng.spago.base.AbstractXMLObject
toDocument, toXML, toXML, toXML, toXML
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

SourceBean

public SourceBean(java.lang.String name)
           throws SourceBeanException
Costruisce un SourceBean vuoto con nome name.

Parameters:
name - nome del SourceBean
Throws:
SourceBeanException - viene lanciata se il parametro di input name non è una nome valido
See Also:
SourceBean(SourceBean)

SourceBean

public SourceBean(SourceBean sourceBean)
           throws SourceBeanException
Costruisce un SourceBean copia di sourceBean.

Parameters:
sourceBean - SourceBean da copiare
Throws:
SourceBeanException - viene lanciata se il parametro di input sourceBean è nullo
See Also:
SourceBean(String)
Method Detail

cloneObject

public CloneableObject cloneObject()
Ritorna un CloneableObject copia non profonda dell'oggetto stesso.

Specified by:
cloneObject in interface CloneableObject
Returns:
una copia non profonda del SourceBean stesso

clearBean

public void clearBean()
Elimina tutto il conenuto del SourceBean.

See Also:
clearBean(String)

clearBean

public void clearBean(java.lang.String key)
Elimina tutto il contenuto del SourceBean corrispondente all'attributo di chiave key.

Parameters:
key - chiave dell'attributo in dot-notation
See Also:
clearBean()

setBean

public void setBean(SourceBean sourceBean)
Copia tutto il contenuto del parametro SourceBean nel proprio stato.

Parameters:
sourceBean - SourceBean di riferimento.

setBean

public void setBean(java.lang.String key,
                    SourceBean sourceBean)
             throws SourceBeanException
Copia il contenuto del parametro SourceBean nel proprio stato a partire dall'attributo con chiave key.

Parameters:
key - String key che identifica un elemento del sourceBean.
sourceBean - SourceBean di riferimento.
Throws:
SourceBeanException - viene lanciata se la chiave non fa riferimento a nessun elemento.

getName

public java.lang.String getName()
Ritorna il nome del SourceBean.

Returns:
il nome del SourceBean
See Also:
SourceBean(String)

getAttributeItem

public java.lang.Object getAttributeItem(java.lang.String key)
Ritorna tutti gli oggetti di tipo SourceBeanAttribute il cui campo chiave vale key.

Parameters:
key - chiave dell'attributo in dot-notation
Returns:
  • null se l'attributo non esiste
  • il SourceBeanAttribute corrispondente alla chiave se l'attributo è single-value
  • List arraylist di SourceBeanAttribute corrispondenti alla chiave se l'attributo è multi-value
See Also:
getAttribute(String)

containsAttribute

public boolean containsAttribute(java.lang.String key)
Ritorna true se l'oggetto sourceBean contiene almento un elemento con chiave key.

Parameters:
key - chiave dell'attributo in dot-notation
Returns:
esito della ricerca dell'elemento.

getAttribute

public java.lang.Object getAttribute(java.lang.String key)
Ritorna tutti i valori dell'attributo con chiave key.

Parameters:
key - chiave dell'attributo in dot-notation
Returns:
  • null se l'attributo non esiste
  • l'oggetto corrispondente alla chiave se l'attributo è single-value
  • List arraylist degli oggetti corrispondenti alla chiave se l'attributo è multi-value
See Also:
setAttribute(String, Object), setAttribute(SourceBean), updAttribute(String, Object), delAttribute(String)

getAttributeAsList

public java.util.List getAttributeAsList(java.lang.String key)
Ritorna tutti i valori dell'attributo con chiave key.

Parameters:
key - chiave dell'attributo in dot-notation
Returns:
List arraylist degli oggetti corrispondenti alla chiave, di dimensione nulla se nessun attributo viene trovato
See Also:
setAttribute(String, Object), setAttribute(SourceBean), updAttribute(String, Object), delAttribute(String)

setAttribute

public void setAttribute(java.lang.String key,
                         java.lang.Object value)
                  throws SourceBeanException
Aggiunge al SourceBean un nuovo attributo con chiave key e valore value. Se il valore dell'attributo è un SourceBean il servizio è equivalente a:
 SourceBean keySourceBean = new SourceBean(key);
 keySourceBean.setAttribute(value);
 this.setAttribute(keySourceBean);
 

Parameters:
key - chiave dell'attributo in dot-notation
value - valore dell'attributo
Throws:
SourceBeanException - viene lanciata in tutti i casi in cui la chiave espressa in dot-notation non sia corretta
See Also:
getAttribute(String), setAttribute(SourceBean), updAttribute(String, Object), delAttribute(String)

setAttribute

public void setAttribute(SourceBean value)
                  throws SourceBeanException
Aggiunge al SourceBean un nuovo attributo il cui valore è un SourceBean. La chiave con cui il secondo SourceBean viene aggiunto è pari al nome del contenitore stesso.

Parameters:
value - SourceBean da aggiungere
Throws:
SourceBeanException - viene lanciata se value è null
See Also:
getAttribute(String), setAttribute(String, Object), updAttribute(String, Object), delAttribute(String)

updAttribute

public void updAttribute(java.lang.String key,
                         java.lang.Object value)
                  throws SourceBeanException
Sostituisce il valore dell'attributo con chiave key con il nuovo valore value. Se l'attributo non esiste viene aggiunto. Nel caso in cui alla chiave corrisponda un attributo multi-value viene lanciata l'eccezione SourceBeanException.

Parameters:
key - chiave dell'attributo in dot-notation
value - valore dell'attributo
Throws:
SourceBeanException - viene lanciata in tutti i casi in cui la chiave espressa in dot-notation non sia corretta
See Also:
getAttribute(String), setAttribute(String, Object), setAttribute(SourceBean), delAttribute(String)

updAttribute

public void updAttribute(SourceBean value)
                  throws SourceBeanException
Throws:
SourceBeanException

delAttribute

public void delAttribute(java.lang.String key)
                  throws SourceBeanException
Elimina tutti i valori dell'attributo con chiave key.

Parameters:
key - chiave dell'attributo in dot-notation
Throws:
SourceBeanException - viene lanciata in tutti i casi in cui la chiave espressa in dot-notation non sia corretta
See Also:
getAttribute(String), setAttribute(String, Object), setAttribute(SourceBean), updAttribute(String, Object)

getCharacters

public java.lang.String getCharacters()
Ritorna il testo contenuto nel SourceBean.

Returns:
il testo contenuto
See Also:
getCharacters(String), setCharacters(String), setCharacters(String, String), delCharacters(), delCharacters(String)

getCharacters

public java.lang.String getCharacters(java.lang.String key)
Ritorna il testo contenuto nel SourceBean corrispondente all'attributo di chiave key.

Parameters:
key - chiave dell'attributo in dot-notation
Returns:
il testo contenuto
See Also:
getCharacters(), setCharacters(String), setCharacters(String, String), delCharacters(), delCharacters(String)

setCharacters

public void setCharacters(java.lang.String characters)
Sostituisce il testo contenuto con quello del parametro characters.

Parameters:
characters - il nuovo testo
See Also:
getCharacters(String), SourceBean#getCharacters(String, String), setCharacters(String, String), delCharacters(), delCharacters(String)

setCharacters

public void setCharacters(java.lang.String key,
                          java.lang.String characters)
                   throws SourceBeanException
Sostituisce il testo contenuto nel SourceBean corrispondente all'attributo di chiave key con quello del parametro characters.

Parameters:
key - chiave dell'attributo in dot-notation
characters - il nuovo testo
Throws:
SourceBeanException
See Also:
getCharacters(String), SourceBean#getCharacters(String, String), setCharacters(String), delCharacters(), delCharacters(String)

delCharacters

public void delCharacters()
Elimina il testo contenuto nel SourceBean.

See Also:
getCharacters(), getCharacters(String), setCharacters(String), setCharacters(String, String), delCharacters(String)

delCharacters

public void delCharacters(java.lang.String key)
Elimina il testo contenuto nel SourceBean corrispondente all'attributo di chiave key.

Parameters:
key - chiave dell'attributo in dot-notation
See Also:
getCharacters(), getCharacters(String), setCharacters(String), setCharacters(String, String), delCharacters()

getFilteredSourceBeanAttributeAsList

public java.util.List getFilteredSourceBeanAttributeAsList(java.lang.String key,
                                                           java.lang.String paramName,
                                                           java.lang.String paramValue)
Ritorna un List contenente tutti i valori dell'attributo con chiave key che sono di tipo SourceBean e contengono un attributo single-value con chiave paramName e valore paramValue.

Parameters:
key - chiave dell'attributo in dot-notation
paramName - nome del parametro di filtro
paramValue - valore del parametro di filtro
Returns:
List arraylist di SourceBean se più valori vengono trovati
See Also:
getAttribute(String)

getFilteredSourceBeanAttribute

public java.lang.Object getFilteredSourceBeanAttribute(java.lang.String key,
                                                       java.lang.String paramName,
                                                       java.lang.String paramValue)
Ritorna tutti i valori dell'attributo con chiave key che sono di tipo SourceBean e contengono un attributo single-value con chiave paramName e valore paramValue.

Parameters:
key - chiave dell'attributo in dot-notation
paramName - nome del parametro di filtro
paramValue - valore del parametro di filtro
Returns:
  • null se nessun valore viene trovato
  • SourceBean se un solo valore viene trovato
  • List arraylist di SourceBean se più valori vengono trovati
See Also:
getAttribute(String)

getContainedAttributes

public java.util.List getContainedAttributes()
Ritorna tutti gli oggetti di tipo SourceBeanAttribute contenuti.

Returns:
List arraylist di SourceBeanAttribute contenuti
See Also:
getContainedAttributes(String), setContainedAttributes(List), setContainedAttributes(String, List), delContainedAttributes(), delContainedAttributes(String)

getContainedAttributes

public java.util.List getContainedAttributes(java.lang.String key)
Ritorna tutti gli oggetti di tipo SourceBeanAttribute contenuti nel SourceBean corrispondente all'attributo di chiave key.

Parameters:
key - chiave dell'attributo in dot-notation
Returns:
List list di SourceBeanAttribute contenuti
See Also:
getContainedAttributes(), setContainedAttributes(List), setContainedAttributes(String, List), delContainedAttributes(), delContainedAttributes(String)

setContainedAttributes

public void setContainedAttributes(java.util.List attributes)
Sostituisce tutti gli oggetti di tipo SourceBeanAttribute contenuti con quelli del vettore attributes.

Parameters:
attributes - List list SourceBeanAttribute dei nuovi attributi
See Also:
getContainedAttributes(), getContainedAttributes(String), setContainedAttributes(String, List), delContainedAttributes(), delContainedAttributes(String)

setContainedAttributes

public void setContainedAttributes(java.lang.String key,
                                   java.util.List attributes)
                            throws SourceBeanException
Sostituisce tutti gli oggetti di tipo SourceBeanAttribute contenuti nel SourceBean corrispondente all'attributo di chiave key con quelli del vettore attributes.

Parameters:
attributes - List list di SourceBeanAttribute dei nuovi attributi
Throws:
SourceBeanException
See Also:
getContainedAttributes(), getContainedAttributes(String), setContainedAttributes(List), delContainedAttributes(), delContainedAttributes(String)

updContainedAttributes

public void updContainedAttributes(java.util.List attributes)
                            throws SourceBeanException
Throws:
SourceBeanException

updContainedAttributes

public void updContainedAttributes(java.lang.String key,
                                   java.util.ArrayList attributes)
                            throws SourceBeanException
Throws:
SourceBeanException

delContainedAttributes

public void delContainedAttributes()
Elimina tutti gli attributi contenuti nel SourceBean.

See Also:
getContainedAttributes(), getContainedAttributes(String), setContainedAttributes(List), setContainedAttributes(String, List), delContainedAttributes(String)

delContainedAttributes

public void delContainedAttributes(java.lang.String key)
Elimina tutti gli attributi contenuti nel SourceBean corrispondente all'attributo di chiave key.

Parameters:
key - chiave dell'attributo in dot-notation
See Also:
getContainedAttributes(), getContainedAttributes(String), setContainedAttributes(List), setContainedAttributes(String, List), delContainedAttributes()

getContainedSourceBeanAttributes

public java.util.List getContainedSourceBeanAttributes()
Ritorna gli oggetti di tipo SourceBeanAttribute contenuti il cui valore associato è di tipo SourceBean.

Returns:
List arrayList di SourceBeanAttribute
See Also:
getContainedSourceBeanAttributes(String), getContainedAttributes(), getContainedAttributes(String)

getContainedSourceBeanAttributes

public java.util.List getContainedSourceBeanAttributes(java.lang.String key)
Ritorna gli oggetti di tipo SourceBeanAttribute contenuti nel SourceBean corrispondente all'attributo di chiave key ed il cui valore associato è di tipo SourceBean.

Parameters:
key - chiave dell'attributo in dot-notation
Returns:
List il vettore di SourceBeanAttribute
See Also:
getContainedSourceBeanAttributes(), getContainedAttributes(), getContainedAttributes(String)

getFullKeyPaths

public java.util.Vector getFullKeyPaths(java.lang.String key)
Ritorna il vettore di chiavi in dot-notation degli attributi a cui è associata la chiave key.

Parameters:
key - chiave dell'attributo non in dot-notation
Returns:
List il vettore di chiavi in dot-notation

fromXMLStream

public static SourceBean fromXMLStream(org.xml.sax.InputSource stream)
                                throws SourceBeanException
Ritorna il SourceBean ottenuto dal parsing dell'InputSource stream.

Parameters:
stream - rappresentazione XML del SourceBean
Returns:
il SourceBean corrispondente allo stream XML
Throws:
SourceBeanException
See Also:
fromXMLString(String), fromXMLFile(String)

fromXMLString

public static SourceBean fromXMLString(java.lang.String xmlSourceBean)
                                throws SourceBeanException
Ritorna il SourceBean ottenuto dal parsing della stringa xmlSourceBean.

Parameters:
xmlSourceBean - rappresentazione XML del SourceBean
Returns:
il SourceBean corrispondente allo stream XML
Throws:
SourceBeanException
See Also:
fromXMLStream(InputSource), fromXMLFile(String)

fromXMLFile

public static SourceBean fromXMLFile(java.lang.String xmlSourceBean)
                              throws SourceBeanException
Ritorna il SourceBean ottenuto dal parsing del file xmlSourceBean.

Parameters:
xmlSourceBean - nome del file che contiene la rappresentazione XML del SourceBean
Returns:
il SourceBean corrispondente allo stream XML
Throws:
SourceBeanException
See Also:
fromXMLStream(InputSource), fromXMLString(String)

toElement

public org.w3c.dom.Element toElement(org.w3c.dom.Document document)
Ritorna un oggetto di tipo Element che verrą utilizzato nella rappresentazione in XML dell'oggetto.

Specified by:
toElement in interface XMLObject
Returns:
Document un oggetto di tipo Document.

toString

public java.lang.String toString()