Squiz Matrix  4.12.2
 All Data Structures Namespaces Functions Variables Pages
Matrix Class Reference

Static Public Member Functions

static final String translate (String key)
 
static final String translate (String key, Object[] arguments)
 
static final void setTranslationFile (String propertiesFile)
 
static final String getProperty (String key)
 
static final String getProperty (String key, String defaultValue)
 
static final void setProperty (String key, String value)
 
static Document doRequest (String xml) throws IOException
 

Detailed Description

An interface to the Matrix system.

Clients of this class call doRequest to send messages to MySource, which is controlled on that side by core/lib/asset_map/asset_map.inc.

This would be where we broadcast our pirate signal and hack into the Matrix...

Author
Marc McIntyre mmcin.nosp@m.tyre.nosp@m.@squi.nosp@m.z.ne.nosp@m.t

Definition at line 43 of file Matrix.java.

Member Function Documentation

static Document doRequest ( String  xml) throws IOException
inlinestatic

Performs an XML request to asset_map.inc.

Parameters
requestThe String of the XML request
Returns
the XML DOM Document response from the Matrix
Exceptions
IOExceptionif connection can't be opened, XML parse error, or an error given by the Matrix

Definition at line 120 of file Matrix.java.

static final String getProperty ( String  key)
inlinestatic

Returns the property with the specfied key

Parameters
keythe key of the wanted property

Definition at line 90 of file Matrix.java.

static final String getProperty ( String  key,
String  defaultValue 
)
inlinestatic

Returns the property with the specfied key or the default value if no property is found with that specified key

Parameters
keythe key of the wanted property
defaultValuethe value to return if no property is found

Definition at line 100 of file Matrix.java.

static final void setProperty ( String  key,
String  value 
)
inlinestatic

Sets the property with the specifed key to the specified value

Parameters
keythe key of the property to set
valuethe value of the property

Definition at line 109 of file Matrix.java.

static final void setTranslationFile ( String  propertiesFile)
inlinestatic

Sets the translation with the specifed key to the specified value

Parameters
keythe key of the translation to set
valuethe value of the translation

Definition at line 78 of file Matrix.java.

static final String translate ( String  key)
inlinestatic

Returns the translation with the specfied key

Parameters
keythe key of the wanted translation

Definition at line 55 of file Matrix.java.

static final String translate ( String  key,
Object[]  arguments 
)
inlinestatic

Returns the translation with the specfied key

Parameters
keythe key of the wanted translation
argumentsthe variable values to be formatted into the translation

Definition at line 66 of file Matrix.java.


The documentation for this class was generated from the following file: