|
||||||||||
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.ResultElementBase
org.gcube.common.searchservice.searchlibrary.resultset.elements.ResultElementGeneric
org.gcube.common.searchservice.searchlibrary.resultset.elements.ResultElementXBean
public class ResultElementXBean
This class acts as a generic placeholder for the records that can be inserted and extracted from the
ResultSet
payload parts treating the
payload as a java bean object.
Field Summary | |
---|---|
static java.lang.String |
RECORD_BEAN_NAME
The name of the searialized bean |
Fields inherited from class org.gcube.common.searchservice.searchlibrary.resultset.elements.ResultElementGeneric |
---|
RECORD_COLLECTION_NAME, RECORD_ID_NAME, RECORD_RANK_NAME |
Constructor Summary | |
---|---|
ResultElementXBean()
Default contructor nessecary for the framework |
|
ResultElementXBean(java.lang.String id,
java.lang.String collection,
java.lang.Object bean)
Constructs a new instance of this class |
Method Summary | |
---|---|
void |
fromXML(java.lang.String xml)
This method must be able to reconstruct the result elelement from a xml string as returned by ResultElementBase.toXML() |
java.lang.Object |
getBean()
Retrieves the payload |
java.lang.String |
getBeanClassName()
Retrieves the name of the bean class |
void |
setBean(java.lang.Object bean)
Sets the bean to serialize |
java.lang.String |
toXML()
This method must return a valid xml serialization of the result record payload. |
Methods inherited from class org.gcube.common.searchservice.searchlibrary.resultset.elements.ResultElementGeneric |
---|
extractValue, getPayload, merge |
Methods inherited from class org.gcube.common.searchservice.searchlibrary.resultset.elements.ResultElementBase |
---|
getRecordAttributes, getRecordAttributes, isValid, RS_fromXML, RS_toXML, setRecordAttributes |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static java.lang.String RECORD_BEAN_NAME
Constructor Detail |
---|
public ResultElementXBean()
public ResultElementXBean(java.lang.String id, java.lang.String collection, java.lang.Object bean) throws java.lang.Exception
id
- The id of the recordcollection
- Teh collection this record belongs tobean
- The bean to serialize
java.lang.Exception
- An unrecoverable for the operaton error occuredMethod Detail |
---|
public void setBean(java.lang.Object bean)
bean
- The beanpublic java.lang.Object getBean()
public java.lang.String getBeanClassName() throws java.lang.Exception
java.lang.Exception
- An unrecoverable for the operaton error occuredpublic java.lang.String toXML() throws java.lang.Exception
ResultElementBase
toXML
in class ResultElementGeneric
java.lang.Exception
- An unrecoverable for the operation error occuredResultElementBase.toXML()
public void fromXML(java.lang.String xml) throws java.lang.Exception
ResultElementBase
ResultElementBase.toXML()
fromXML
in class ResultElementGeneric
xml
- The serialized string to populate the insance from
java.lang.Exception
- An unrecoverable for the operation error occuredResultElementBase.fromXML(java.lang.String)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |