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

java.lang.Object
  extended by org.gcube.common.searchservice.searchlibrary.resultset.elements.PropertyElementBase
      extended by org.gcube.common.searchservice.searchlibrary.resultset.elements.PropertyElementWellFormed

public class PropertyElementWellFormed
extends PropertyElementBase

Property Element that is used to set a specific the form of a text ResultSet

Author:
uoA
See Also:
PropertyElementBase

Field Summary
static java.lang.String NO
          The RS is not well formed
static java.lang.String propertyType
          The Type of the Property this Property element produces
static java.lang.String YES
          The RS is well formed
 
Constructor Summary
PropertyElementWellFormed()
          Default contructor required by PropertyElementBase
PropertyElementWellFormed(java.lang.String wellformed)
          Initializes a new PropertyElementWellFormed
 
Method Summary
 void fromXML(java.lang.String xml)
          Method to be implemented that will handle the population of the custom Property element.
 java.lang.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
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

propertyType

public static java.lang.String propertyType
The Type of the Property this Property element produces


YES

public static java.lang.String YES
The RS is well formed


NO

public static java.lang.String NO
The RS is not well formed

Constructor Detail

PropertyElementWellFormed

public PropertyElementWellFormed()
Default contructor required by PropertyElementBase


PropertyElementWellFormed

public PropertyElementWellFormed(java.lang.String wellformed)
                          throws java.lang.Exception
Initializes a new PropertyElementWellFormed

Parameters:
wellformed - Whether or not this ResultSet is wellformed
Throws:
java.lang.Exception - An unrecoverable for the operation error occured
Method Detail

toXML

public java.lang.String toXML()
                       throws java.lang.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:
java.lang.Exception - An unrecoverable for the operation error occured
See Also:
PropertyElementBase.toXML()

fromXML

public void fromXML(java.lang.String xml)
             throws java.lang.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:
java.lang.Exception - An unrecoverable for the operation error occured
See Also:
PropertyElementBase.fromXML(java.lang.String)