org.licas.service.resource

Class ObjResource

java.lang.Object

org.licas.service.resource.Resource

org.licas.service.resource.ObjResource

public class ObjResource
extends Resource

This is a generic type of resource to store any information Object directly. It might be used for basic types, such as Integer or Float, for example. Alternatively, you can specify a parser and serialize/parse your own Java objects. This automatically loads the contents in and does not dynamically retrieve each time.

Author:

Kieran Greer

Field Summary

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
ObjResource(java.lang.String theDataType, org.licas_xml.abs.Element dataXml) Create a new instance of ObjResource.
ObjResource(java.lang.String theDataType, java.lang.Object theData) Create a new instance of ObjResource.

Method Summary

Modifier and Type	Method and Description
org.licas_xml.abs.Element	getInfo(org.licas_xml.abs.Element infoDescr) Get the currently loaded source information wrapped in an XML element.
java.lang.Object	getValue(org.licas_xml.abs.Element infoDescr) Get the 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.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

ObjResource

public ObjResource(java.lang.String theDataType,
                   java.lang.Object theData)
            throws java.lang.Exception

Create a new instance of ObjResource.

Parameters:

theDataType - the resource data type.

theData - the data object. This is stored as is, do not need to parse anything.

Throws:

java.lang.Exception - any error.

ObjResource

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

Create a new instance of ObjResource.

Parameters:

theDataType - the resource data type.

dataXml - a description of the initialisation parameters. Can be null.

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. This version should retrieve a string-based description and try to parse it into the data object.

Specified by:

parseInfo in class Resource

Parameters:

dataXml - the Data element of the admin document. This should include a Value element that stores a String-based file path description and possibly an Action element. If there is no specified action, then the data is loaded into the resource as default. There can also be a Parser element, as specified by MetaFactory.createParserXML.

Returns:

true if the file was successfully loaded, 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 currently loaded 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. Can be null as not used in this version.

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 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. Can be null as not used in this version.

Returns:

the info value.

Throws:

java.lang.Exception - any error.