|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.gcube.common.searchservice.searchlibrary.resultset.elements.PropertyElementBase
public abstract class PropertyElementBase
This class is the base class that must be extended by anyone wishing to implement a custom Property element class. Every class extending this one must define an accessible default constructor with an empty argument list
Constructor Summary | |
---|---|
PropertyElementBase()
|
Method Summary | |
---|---|
abstract void |
fromXML(java.lang.String xml)
Method to be implemented that will handle the population of the custom Property element. |
java.lang.String |
getType()
Retrieves the Type of the current property |
static java.lang.String |
getType(java.lang.String xml)
Retrieves the Type of the provided property serialization |
void |
RS_fromXML(java.lang.String xml)
Populates the current property element with provided property serialization |
java.lang.String |
RS_toXML()
Creates a serialization of the current property element that can be added to the ResultSet
head part. |
void |
setType(java.lang.String type)
Sets the Type of the current property element |
abstract java.lang.String |
toXML()
Method to be implemented that will handle the serialization of the custom Property element. |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public PropertyElementBase()
Method Detail |
---|
public final java.lang.String getType() throws java.lang.Exception
java.lang.Exception
- An unrecoverable for the operation error has occuredpublic final void setType(java.lang.String type) throws java.lang.Exception
type
- The type this property element has
java.lang.Exception
- An unrecoverable for the operation error has occuredpublic static final java.lang.String getType(java.lang.String xml) throws java.lang.Exception
xml
- the serialixed property
java.lang.Exception
- An unrecoverable for the operation error has occuredpublic final java.lang.String RS_toXML() throws java.lang.Exception
ResultSet
head part.
java.lang.Exception
- An unrecoverable for the operation error has occuredpublic final void RS_fromXML(java.lang.String xml) throws java.lang.Exception
xml
- The serialized property
java.lang.Exception
- An unrecoverable for the operation error has occuredpublic abstract void fromXML(java.lang.String xml) throws java.lang.Exception
RS_fromXML(String)
after it has striped the xml
serialization of the type property
xml
- The striped xml serialization the custom property element must handle
java.lang.Exception
- The extending element can specify the Exception that is throwntoXML()
public abstract java.lang.String toXML() throws java.lang.Exception
RS_toXML()
which then enriches the returned serialization
to produce a valid property xml string
java.lang.Exception
- The extending element can specify the Exception that is thrownPropertyElementBase#fromXML()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |