r01f.xmlproperties
Class XMLPropertiesManager.ComponentProperties

java.lang.Object
  r01f.xmlproperties.XMLPropertiesManager.ComponentProperties

Enclosing class:

XMLPropertiesManager

public class XMLPropertiesManager.ComponentProperties
extends java.lang.Object

Encapsula el acceso a las propiedades de un componente.

Field Summary

private java.lang.String	_component
private java.lang.String	_theAppCode

Constructor Summary

XMLPropertiesManager.ComponentProperties(java.lang.String appCode, java.lang.String component)
Constructor en base al código de aplicación y componente.

Method Summary

boolean	existProperty(java.lang.String propXPath) Comprueba si una propiedad está definida en el fichero de propiedades.
boolean	getBoolean(java.lang.String propXPath) Devuelve una propiedad como un Boolean.
boolean	getBoolean(java.lang.String propXPath, boolean defaultValue) Devuelve una propiedad como un boolean o el valor por defecto que se pasa si la propiedad es null.
float	getFloat(java.lang.String propXPath) Devuelve una propiedad como un float.
float	getFloat(java.lang.String propXPath, float defaultValue) Devuelve una propiedad como un float o el valor por defecto que se pasa si la propiedad es null.
int	getInteger(java.lang.String propXPath) Devuelve una propiedad como un int.
int	getInteger(java.lang.String propXPath, int defaultValue) Devuelve una propiedad como un int o el valor por defecto que se pasa si la propiedad es null.
java.util.List<java.lang.String>	getListOfStrings(java.lang.String propXPath) Devuelve una propiedad como una lista de Strings con los valores que están por debajo del tag que se pasa en la sentencia xPath.
java.util.List<java.lang.String>	getListOfStrings(java.lang.String propXPath, java.util.List<java.lang.String> defaultValue) Devuelve una propiedad como una lista de Strings con los valores que están por debajo del tag que se pasa en la sentencia xPath.
java.lang.Number	getNumber(java.lang.String propXPath) Devuelve una propiedad como un Number.
java.lang.Number	getNumber(java.lang.String propXPath, java.lang.Number defaultValue) Devuelve una propiedad como un Number o el valor por defecto que se pasa si la propiedad es null.
<T> T	getObject(java.lang.String propXPath, java.lang.Class<T> objType, Marshaller marshaller) Devuelve un objeto a partir de una porción del XML de propiedades.
java.util.Properties	getProperties(java.lang.String propXPath) Devuelve una propiedad como un Properties de los valores que están por debajo del tag que se pasa en la sentencia xPath.
java.util.Properties	getProperties(java.lang.String propXPath, java.util.Properties defaultValue) Devuelve una propiedad como un Properties de los valores que están por debajo del tag que se pasa en la sentencia xPath.
ResourcesLoaderDef	getResourcesLoaderDef(java.lang.String propXPath) Devuelve la propiedad como un objeto de definición de carga de recursos ResourcesLoaderDef (obviamente el XML tiene que tener la estrucutra impuesta por ResourcesLoaderDef).
java.lang.String	getString(java.lang.String propXPath) Devuelve una propiedad como un String.
java.lang.String	getString(java.lang.String propXPath, java.lang.String defaultValue) Devuelve una propiedad como String o el valor por defecto que se pasa si la propiedad es null.
Strings.StringWrapper	getStringWrapped(java.lang.String propXPath) Devuelve la propiedad en forma de cadena envuelta en forma de fluent API para realizar operaciones posteriores con el valor de la propiedad.
Strings.StringWrapper	getStringWrapped(java.lang.String propXPath, java.lang.String defaultValue) Devuelve la propiedad en forma de cadena envuelta en forma de fluent API para realizar operaciones posteriores con el valor de la propiedad, si no está definida el valor especificado por defecto.

Methods inherited from class java.lang.Object

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

Field Detail

_theAppCode

private java.lang.String _theAppCode

_component

private java.lang.String _component

Constructor Detail

XMLPropertiesManager.ComponentProperties

XMLPropertiesManager.ComponentProperties(java.lang.String appCode,
                                         java.lang.String component)

Constructor en base al código de aplicación y componente.

Parameters:

component - Componente de la aplicación.

Method Detail

existProperty

public boolean existProperty(java.lang.String propXPath)

Comprueba si una propiedad está definida en el fichero de propiedades.

Parameters:

propXPath - Ruta xpth de la propiedad.

Returns:

true si la propiedad está definida en el fichero, false en otro caso.

getString

public java.lang.String getString(java.lang.String propXPath)

Devuelve una propiedad como un String.

Parameters:

propXPath - La ruta XPath de la propiedad.

Returns:

Un string con la propiedad o null si la propiedad no existe.

getString

public java.lang.String getString(java.lang.String propXPath,
                                  java.lang.String defaultValue)

Devuelve una propiedad como String o el valor por defecto que se pasa si la propiedad es null.

Parameters:

defaultValue - Valor por defecto para la propiedad.

Returns:

El valor de la propiedad o el valor por defecto que se pasa si la propiedad es null.

getStringWrapped

public Strings.StringWrapper getStringWrapped(java.lang.String propXPath)

Devuelve la propiedad en forma de cadena envuelta en forma de fluent API para realizar operaciones posteriores con el valor de la propiedad.
(ver http://download.oracle.com/javase/1.5.0/docs/api/index.html?java/util/Formatter.html)

                Calendar cal = new GregorianCalendar(1995, MAY, 23)
                String theProp = props.of("xxx","comp").getStringWrapped("xPath").format(cal).asString();
 

Si la propiedad es por ejemplo "Duke's Birthday: %1$tm %1$te,%1$tY",
el valor de theProp tras la llamada anterior sera: Duke's Birthday: May 23, 1995

Parameters:

propXPath - La ruta XPath de la propiedad.

Returns:

La propiedad en forma de cadena.

getStringWrapped

public Strings.StringWrapper getStringWrapped(java.lang.String propXPath,
                                              java.lang.String defaultValue)

Devuelve la propiedad en forma de cadena envuelta en forma de fluent API para realizar operaciones posteriores con el valor de la propiedad, si no está definida el valor especificado por defecto.
(ver http://download.oracle.com/javase/1.5.0/docs/api/index.html?java/util/Formatter.html)

                Calendar cal = new GregorianCalendar(1995, MAY, 23)
                String theProp = props.of("xxx","comp").getStringWrapped("xPath").format(cal).asString();
 

Si la propiedad es por ejemplo "Duke's Birthday: %1$tm %1$te,%1$tY",
el valor de theProp tras la llamada anterior sera: Duke's Birthday: May 23, 1995

Parameters:

propXPath - La ruta XPath de la propiedad.

defaultValue - Valor por defecto en caso de no existir.

Returns:

La propiedad en forma de cadena.

getNumber

public java.lang.Number getNumber(java.lang.String propXPath)

Devuelve una propiedad como un Number.

Parameters:

propXPath - La ruta XPath de la propiedad.

Returns:

Un string con la propiedad o null si la propiedad no existe.

getNumber

public java.lang.Number getNumber(java.lang.String propXPath,
                                  java.lang.Number defaultValue)

Devuelve una propiedad como un Number o el valor por defecto que se pasa si la propiedad es null.

Parameters:

propXPath - La ruta XPath de la propiedad.

defaultValue - Valor por defecto para la propiedad.

Returns:

El valor de la propiedad o el valor por defecto que se pasa si la propiedad es null.

getInteger

public int getInteger(java.lang.String propXPath)

Devuelve una propiedad como un int.

Parameters:

propXPath - La ruta XPath de la propiedad.

Returns:

Un string con la propiedad o null si la propiedad no existe.

getInteger

public int getInteger(java.lang.String propXPath,
                      int defaultValue)

Devuelve una propiedad como un int o el valor por defecto que se pasa si la propiedad es null.

Parameters:

propXPath - La ruta XPath de la propiedad.

defaultValue - Valor por defecto para la propiedad.

Returns:

El valor de la propiedad o el valor por defecto que se pasa si la propiedad es null.

getFloat

public float getFloat(java.lang.String propXPath)

Devuelve una propiedad como un float.

Parameters:

propXPath - La ruta XPath de la propiedad.

Returns:

Un string con la propiedad o null si la propiedad no existe.

getFloat

public float getFloat(java.lang.String propXPath,
                      float defaultValue)

Devuelve una propiedad como un float o el valor por defecto que se pasa si la propiedad es null.

Parameters:

propXPath - La ruta XPath de la propiedad.

defaultValue - Valor por defecto para la propiedad.

Returns:

El valor de la propiedad o el valor por defecto que se pasa si la propiedad es null.

getBoolean

public boolean getBoolean(java.lang.String propXPath)

Devuelve una propiedad como un Boolean.

Parameters:

propXPath - La ruta XPath de la propiedad.

Returns:

Un string con la propiedad o false si la propiedad no existe.

getBoolean

public boolean getBoolean(java.lang.String propXPath,
                          boolean defaultValue)

Devuelve una propiedad como un boolean o el valor por defecto que se pasa si la propiedad es null.

Parameters:

propXPath - La ruta XPath de la propiedad.

defaultValue - Valor por defecto para la propiedad.

Returns:

El valor de la propiedad o el valor por defecto que se pasa si la propiedad es null.

getProperties

public java.util.Properties getProperties(java.lang.String propXPath)

Devuelve una propiedad como un Properties de los valores que están por debajo del tag que se pasa en la sentencia xPath.
Ej: si el xPath llega a <myProperties> <itemName1>value1</itemName1> <itemName2>value2</itemName2> ... </myProperties>
devuelve un objeto properties:{[itemName1,value1],[itemName2,value2]...}.

Parameters:

propXPath - Ruta XPath al nodo padre de los elementos a poner el objeto Properties.

Returns:

Un objeto Properties.

getProperties

public java.util.Properties getProperties(java.lang.String propXPath,
                                          java.util.Properties defaultValue)

Devuelve una propiedad como un Properties de los valores que están por debajo del tag que se pasa en la sentencia xPath.
Ej: si el xPath llega a <myProperties> <itemName1>value1</itemName1> <itemName2>value2</itemName2> ... </myProperties>
devuelve un objeto properties:{[itemName1,value1],[itemName2,value2]...}.

Parameters:

propXPath - Ruta XPath al nodo padre de los elementos a poner el objeto Properties.

defaultValue - Properties por defecto

Returns:

Un objeto Properties.

getListOfStrings

public java.util.List<java.lang.String> getListOfStrings(java.lang.String propXPath)

Devuelve una propiedad como una lista de Strings con los valores que están por debajo del tag que se pasa en la sentencia xPath.
Ej: si el xPath llega a <myList> <item>value1</item> <item>value2</item> ... </myList>
devuelve un objeto List{value1,value2...}.

Parameters:

propXPath - Ruta XPath al nodo padre de los elementos a poner el objeto List.

Returns:

Un objeto List.

getListOfStrings

public java.util.List<java.lang.String> getListOfStrings(java.lang.String propXPath,
                                                         java.util.List<java.lang.String> defaultValue)

Devuelve una propiedad como una lista de Strings con los valores que están por debajo del tag que se pasa en la sentencia xPath.
Ej: si el xPath llega a <myList> <item>value1</item> <item>value2</item> ... </myList>
devuelve un objeto List{value1,value2...}.

Parameters:

propXPath - Ruta XPath al nodo padre de los elementos a poner el objeto List.

defaultValue - Lista de Strings por defecto.

Returns:

Un objeto List.

getObject

public <T> T getObject(java.lang.String propXPath,
                       java.lang.Class<T> objType,
                       Marshaller marshaller)

Devuelve un objeto a partir de una porción del XML de propiedades.
La transformación de XML a objetos se hace utilizando el Marshaller de R01.

Parameters:

propXPath - La ruta al tag que engloba el objeto.

objType - El tipo de objeto.

Returns:

El objeto obtenido del XML.

getResourcesLoaderDef

public ResourcesLoaderDef getResourcesLoaderDef(java.lang.String propXPath)

Devuelve la propiedad como un objeto de definición de carga de recursos ResourcesLoaderDef (obviamente el XML tiene que tener la estrucutra impuesta por ResourcesLoaderDef).

Returns:

Un objeto ResourcesLoaderDef.

See Also:

ResourcesLoaderDef