org.gcube.common.searchservice.searchlibrary.resultset.elements

Class PropertyElementGC

java.lang.Object

org.gcube.common.searchservice.searchlibrary.resultset.elements.PropertyElementBase

org.gcube.common.searchservice.searchlibrary.resultset.elements.PropertyElementGC

public class PropertyElementGC
extends PropertyElementBase

Property Element that is used to set a specific ssid to the ResultSet

Author:

uoA

See Also:

PropertyElementBase

Field Summary

Fields

Modifier and Type	Field and Description
static String	propertyType The Type of the Property this Property element produces
static String	unspecified Specifying that there is no SSID provided

Constructor Summary

Constructors

Constructor and Description
PropertyElementGC() Default contructor required by PropertyElementBase
PropertyElementGC(String ssid) Initializes a new PropertyElementLifeSpanGC

Method Summary

Methods

Modifier and Type	Method and Description
void	fromXML(String xml) Method to be implemented that will handle the population of the custom Property element.
String	toXML() Method to be implemented that will handle the serialization of the custom Property element.

Methods inherited from class org.gcube.common.searchservice.searchlibrary.resultset.elements.PropertyElementBase

getType, getType, RS_fromXML, RS_toXML, setType

Methods inherited from class java.lang.Object

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

Field Detail

propertyType

public static String propertyType

The Type of the Property this Property element produces

unspecified

public static String unspecified

Specifying that there is no SSID provided

Constructor Detail

PropertyElementGC

public PropertyElementGC()

Default contructor required by PropertyElementBase

PropertyElementGC

public PropertyElementGC(String ssid)
                  throws Exception

Initializes a new PropertyElementLifeSpanGC

Parameters:

ssid - The ssid of this ResultSet

Throws:

Exception - An unrecoverable for the operation error occured

Method Detail

toXML

public String toXML()
             throws Exception

Description copied from class: PropertyElementBase

Method to be implemented that will handle the serialization of the custom Property element. It is called by the PropertyElementBase.RS_toXML() which then enriches the returned serialization to produce a valid property xml string

Specified by:

toXML in class PropertyElementBase

Returns:

The serialized property payload

Throws:

Exception - An unrecoverable for the operation error occured

See Also:

PropertyElementBase.toXML()

fromXML

public void fromXML(String xml)
             throws Exception

Description copied from class: PropertyElementBase

Method to be implemented that will handle the population of the custom Property element. It is called by the PropertyElementBase.RS_fromXML(String) after it has striped the xml serialization of the type property

Specified by:

fromXML in class PropertyElementBase

Parameters:

xml - The serialized string to populate the insance from

Throws:

Exception - An unrecoverable for the operation error occured

See Also:

PropertyElementBase.fromXML(java.lang.String)