org.licas.service.resource.container

Class RandomContainer

java.lang.Object

org.licas.service.resource.Resource

org.licas.service.resource.container.ResourceContainer

org.licas.service.resource.container.RandomContainer

public class RandomContainer
extends ResourceContainer

This can be used to store an array or set of Resource derived objects and randomly return the details of one of them upon request.

Author:

Kieran Greer

Field Summary

Fields inherited from class org.licas.service.resource.container.ResourceContainer

resourceList

Fields inherited from class org.licas.service.resource.Resource

dataType, INFOANYTYPE, INFOBINARYTYPE, INFOHTMLTYPE, INFOSTREAMXMLTYPE, INFOSTRINGTYPE, INFOTEXTTYPE, INFOURLTYPE, INFOXMLTYPE, LISTCONTAINERTYPE, QUERYCONTAINERTYPE, RANDOMCONTAINERTYPE, uuid

Constructor Summary

Constructors

Constructor and Description
RandomContainer(java.lang.String theDataType) Create a new instance of RandomContainer.
RandomContainer(java.lang.String theDataType, org.licas_xml.abs.Element dataXml) Create a new instance of RandomContainer.

Method Summary

Modifier and Type	Method and Description
org.licas_xml.abs.Element	getInfo(org.licas_xml.abs.Element infoDescr) Get the source information wrapped in an XML element.
java.lang.Object	getValue(org.licas_xml.abs.Element infoDescr) Get the currently selected value itself and not a wrapped description.
protected boolean	parseInfo(org.licas_xml.abs.Element dataXml) Parse the data description in the admin document to create the data object.

Methods inherited from class org.licas.service.resource.container.ResourceContainer

addResource, createContainer, getResource, getResourceIDs, removeResource

Methods inherited from class org.licas.service.resource.Resource

createResource, dataFromResourceType, getDataType, getUUID, parseValueElem, resourceTypeForDataType, setUUID, setUUID

Methods inherited from class java.lang.Object

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

Constructor Detail

RandomContainer

public RandomContainer(java.lang.String theDataType)
                throws java.lang.Exception

Create a new instance of RandomContainer.

Parameters:

theDataType - the container type.

Throws:

java.lang.Exception - any error.

RandomContainer

public RandomContainer(java.lang.String theDataType,
                       org.licas_xml.abs.Element dataXml)
                throws java.lang.Exception

Create a new instance of RandomContainer.

Parameters:

theDataType - the container type.

dataXml - a description of the initialisation parameters.

Throws:

java.lang.Exception - any error.

Method Detail

parseInfo

protected boolean parseInfo(org.licas_xml.abs.Element dataXml)
                     throws java.lang.Exception

Parse the data description in the admin document to create the data object.

Overrides:

parseInfo in class ResourceContainer

Parameters:

dataXml - the Data element of the admin document. This should include the container DataType element and a Value element that stores a list of child Data elements that store information for each resource to create. The Value element can also optionally store the random number generator initialisation value (of type long). If this is missing, then the current date is used. This would be another Value element that could be created using MetaFactory.addXML(adminData, (MetaFactory.createMetaValueXML(Const.VALUE, rnd-init), Const.VALUE), for example.

Returns:

true if any specified resources are successfully added, false otherwise.

Throws:

java.lang.Exception - any error.

getInfo

public org.licas_xml.abs.Element getInfo(org.licas_xml.abs.Element infoDescr)
                                  throws java.lang.Exception

Get the source information wrapped in an XML element.

Specified by:

getInfo in class Resource

Parameters:

infoDescr - a description of the info resource value that should be retrieved.

Returns:

the value of the resource info as an XML element. This format is consistent with adding a 'Data' element through an admin document.

Throws:

java.lang.Exception - any error.

getValue

public java.lang.Object getValue(org.licas_xml.abs.Element infoDescr)
                          throws java.lang.Exception

Get the currently selected value itself and not a wrapped description.

Specified by:

getValue in class Resource

Parameters:

infoDescr - a description of the info resource value that should be retrieved.

Returns:

the info value.

Throws:

java.lang.Exception - any error.