edu.vt.marian.WebGate
Class results

java.lang.Object
  |
  +--edu.vt.marian.WebGate.results

public class results

extends java.lang.Object

Class name: results Class description: this class represent the results of a query Author: Jianxin Zhao Finished time: ????, 1998 Known bugs: none Platform: jdk1.1.5 under UNIX

Constructor Summary

results(java.io.DataInputStream dis, edu.vt.marian.common.Debug debug)
this mehod will create a results object from a stream, this might be helpful for remote management in the future .

results(java.lang.String dir, edu.vt.marian.common.Debug debug)
this constructor will create a results object from the specified directory/file

results(java.util.Vector server_list, edu.vt.marian.common.Debug debug)
this constructor will create a results object, the object is empty upon creation

Method Summary

boolean	all_in_state(java.lang.String state) this method will tell whether or not all the servers of this object is in the specified state
java.lang.String	get_circulation() this method will return the circulation information of this object
edu.vt.marian.common.WtdEntireObj	get_doc(java.lang.String index) this method will return the document at the specified index of this results object
edu.vt.marian.common.WtdEntireObj	get_doc(edu.vt.marian.uip.uip_server us, java.lang.String index) this method will return the document at the specified index of this results object which come from the specified uip server
java.util.Vector	get_docs() this method will return all the documents currently contained in this results object
java.lang.String	get_docs(general_query_data gqd) this method will the documents of this object which match the specified query data.
java.util.Vector	get_docs(java.lang.String start_index, java.lang.String end_index) this method will return all the documents from the start index to the end index in this results object
java.util.Vector	get_docs(edu.vt.marian.uip.uip_server us) this method will return all the documents currently contained in this results object which come from the specified uip server
java.lang.String	get_docs(edu.vt.marian.uip.uip_server us, general_query_data gqd) this method will the documents of this object which come from the specified server and also match the specified query data
java.util.Vector	get_docs(edu.vt.marian.uip.uip_server us, java.lang.String start_index, java.lang.String end_index) this method will return all the documents from the start index to the end index coresponds to the specified uip server in this results object (not implemented yet)
java.lang.String	get_long_description_in_html(java.lang.String start_index, java.lang.String end_index) theis method will return the long description of the specified documents in html format.
java.lang.String	get_long_description_in_html(edu.vt.marian.uip.uip_server us, java.lang.String start_index, java.lang.String end_index) theis method will return the long description of the specified documents which come from the specified server in html format.
java.lang.String	get_long_description_in_html(edu.vt.marian.uip.uip_server us, java.util.Vector doc_indexes) theis method will return the long description of the specified documents which come from the specified server in html format.
java.lang.String	get_long_description_in_html(java.util.Vector doc_indexes) theis method will return the long description of the specified documents in html format.
java.lang.String	get_number_docs() this method will return the number of documents in this object.
java.lang.String	get_number_docs(general_query_data gqd) this method will the number of documents in this object which match the specified query data.
java.lang.String	get_number_docs(edu.vt.marian.uip.uip_server us) this method will return the number of documents in this object about the specified uip server, note the documents in a results object may come from different servers, the meaning of the return value is the same as the above methods
java.lang.String	get_number_docs(edu.vt.marian.uip.uip_server us, general_query_data gqd) this method will the number of documents of this object which come from the specified server and also match the specified query data
java.lang.String	get_ready_time() this method will return the time when the result is ready, it's helpful for system performance measure.
java.lang.String	get_ready_time(edu.vt.marian.uip.uip_server us) this method will return the time when the result from the specified server is ready.
edu.vt.marian.uip.uip_server	get_server_by_doc_number(java.lang.String doc_number) this method will return the uip server from which the specified document came
java.util.Vector	get_server_list() this method will return the current servers this object is corresponds to
java.util.Vector	get_servers_in_state(java.lang.String state) this method will return the servers which are in the specified state
java.lang.String	get_short_description_in_html(java.lang.String start_index, java.lang.String end_index) this method will return the short descriptions of the specified documents in html format.
java.lang.String	get_short_description_in_html(edu.vt.marian.uip.uip_server us, java.lang.String start_index, java.lang.String end_index) this method will return the short descriptions of the specified documents which come from the specified server in html format.
java.lang.String	get_short_description_in_html(edu.vt.marian.uip.uip_server us, java.util.Vector doc_indexes) this method will return the short descriptions of the specified documents which come from the specified server in html format.
java.lang.String	get_short_description_in_html(java.util.Vector doc_indexes) this method will return the short descriptions of the specified documents in html format.
java.lang.String	get_status() this method will return the current status of this results object status will tell something like whether or not all documents are ready.
java.lang.String	get_status(edu.vt.marian.uip.uip_server us) this method will return the status of documents corresponds to the specified server
java.lang.String	save(java.lang.String dir) this method will save the content of this object to the specified file
java.lang.String	set_circulation(java.lang.String circulation) this method will set the circulation information of this object
java.lang.String	set_status(java.lang.String s) this method will set the status of this object
java.lang.String	set_status(java.util.Vector uip_servers, java.lang.String s) this method will set the status of the specified servers to the specified value
java.lang.String	store_docs(edu.vt.marian.uip.uip_server us, java.util.Vector docs, java.lang.String more_to_come) this method will store a number of documents from the specified uip server to the results object, the parameter more_to_come specifys whether or not this is the last bounch documents come from that server
java.lang.String	to_stream(java.io.DataOutputStream dos) this method will print the content of this object to a stream, this might be useful for remote management in the future.

Methods inherited from class java.lang.Object

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

Constructor Detail

results

public results(java.util.Vector server_list,
               edu.vt.marian.common.Debug debug)

this constructor will create a results object, the object is empty upon creation

results

public results(java.lang.String dir,
               edu.vt.marian.common.Debug debug)

this constructor will create a results object from the specified directory/file

results

public results(java.io.DataInputStream dis,
               edu.vt.marian.common.Debug debug)

this mehod will create a results object from a stream, this might be helpful for remote management in the future . (not implemented yet)

Method Detail

get_server_list

public java.util.Vector get_server_list()

this method will return the current servers this object is corresponds to

get_server_by_doc_number

public edu.vt.marian.uip.uip_server get_server_by_doc_number(java.lang.String doc_number)

this method will return the uip server from which the specified document came

store_docs

public java.lang.String store_docs(edu.vt.marian.uip.uip_server us,
                                   java.util.Vector docs,
                                   java.lang.String more_to_come)

this method will store a number of documents from the specified uip server to the results object, the parameter more_to_come specifys whether or not this is the last bounch documents come from that server

set_circulation

public java.lang.String set_circulation(java.lang.String circulation)

this method will set the circulation information of this object

get_circulation

public java.lang.String get_circulation()

this method will return the circulation information of this object

set_status

public java.lang.String set_status(java.lang.String s)

this method will set the status of this object

get_status

public java.lang.String get_status()

this method will return the current status of this results object status will tell something like whether or not all documents are ready.

set_status

public java.lang.String set_status(java.util.Vector uip_servers,
                                   java.lang.String s)

this method will set the status of the specified servers to the specified value

get_status

public java.lang.String get_status(edu.vt.marian.uip.uip_server us)

this method will return the status of documents corresponds to the specified server

all_in_state

public boolean all_in_state(java.lang.String state)

this method will tell whether or not all the servers of this object is in the specified state

get_servers_in_state

public java.util.Vector get_servers_in_state(java.lang.String state)

this method will return the servers which are in the specified state

get_ready_time

public java.lang.String get_ready_time()

this method will return the time when the result is ready, it's helpful for system performance measure. (not implemented yet)

get_ready_time

public java.lang.String get_ready_time(edu.vt.marian.uip.uip_server us)

this method will return the time when the result from the specified server is ready. (not implemented yet)

get_number_docs

public java.lang.String get_number_docs()

this method will return the number of documents in this object.

get_number_docs

public java.lang.String get_number_docs(general_query_data gqd)

this method will the number of documents in this object which match the specified query data. (not implemented yet)

get_number_docs

public java.lang.String get_number_docs(edu.vt.marian.uip.uip_server us)

this method will return the number of documents in this object about the specified uip server, note the documents in a results object may come from different servers, the meaning of the return value is the same as the above methods

get_number_docs

public java.lang.String get_number_docs(edu.vt.marian.uip.uip_server us,
                                        general_query_data gqd)

this method will the number of documents of this object which come from the specified server and also match the specified query data

get_doc

public edu.vt.marian.common.WtdEntireObj get_doc(java.lang.String index)

this method will return the document at the specified index of this results object

get_doc

public edu.vt.marian.common.WtdEntireObj get_doc(edu.vt.marian.uip.uip_server us,
                                                 java.lang.String index)

this method will return the document at the specified index of this results object which come from the specified uip server

get_docs

public java.util.Vector get_docs()

this method will return all the documents currently contained in this results object

get_docs

public java.lang.String get_docs(general_query_data gqd)

this method will the documents of this object which match the specified query data. (not implemented yet)

get_docs

public java.util.Vector get_docs(edu.vt.marian.uip.uip_server us)

this method will return all the documents currently contained in this results object which come from the specified uip server

get_docs

public java.lang.String get_docs(edu.vt.marian.uip.uip_server us,
                                 general_query_data gqd)

this method will the documents of this object which come from the specified server and also match the specified query data

get_docs

public java.util.Vector get_docs(java.lang.String start_index,
                                 java.lang.String end_index)

this method will return all the documents from the start index to the end index in this results object

get_docs

public java.util.Vector get_docs(edu.vt.marian.uip.uip_server us,
                                 java.lang.String start_index,
                                 java.lang.String end_index)

this method will return all the documents from the start index to the end index coresponds to the specified uip server in this results object (not implemented yet)

get_short_description_in_html

public java.lang.String get_short_description_in_html(java.util.Vector doc_indexes)

this method will return the short descriptions of the specified documents in html format. (not implemented yet)

get_short_description_in_html

public java.lang.String get_short_description_in_html(java.lang.String start_index,
                                                      java.lang.String end_index)

this method will return the short descriptions of the specified documents in html format. (not implemented yet)

get_short_description_in_html

public java.lang.String get_short_description_in_html(edu.vt.marian.uip.uip_server us,
                                                      java.util.Vector doc_indexes)

this method will return the short descriptions of the specified documents which come from the specified server in html format. (not implemented yet)

get_short_description_in_html

public java.lang.String get_short_description_in_html(edu.vt.marian.uip.uip_server us,
                                                      java.lang.String start_index,
                                                      java.lang.String end_index)

this method will return the short descriptions of the specified documents which come from the specified server in html format. (not implemented yet)

get_long_description_in_html

public java.lang.String get_long_description_in_html(java.util.Vector doc_indexes)

theis method will return the long description of the specified documents in html format. (not implemented yet)

get_long_description_in_html

public java.lang.String get_long_description_in_html(java.lang.String start_index,
                                                     java.lang.String end_index)

theis method will return the long description of the specified documents in html format. (not implemented yet)

get_long_description_in_html

public java.lang.String get_long_description_in_html(edu.vt.marian.uip.uip_server us,
                                                     java.util.Vector doc_indexes)

theis method will return the long description of the specified documents which come from the specified server in html format. (not implemented yet)

get_long_description_in_html

public java.lang.String get_long_description_in_html(edu.vt.marian.uip.uip_server us,
                                                     java.lang.String start_index,
                                                     java.lang.String end_index)

theis method will return the long description of the specified documents which come from the specified server in html format. (not implemented yet)

to_stream

public java.lang.String to_stream(java.io.DataOutputStream dos)

this method will print the content of this object to a stream, this might be useful for remote management in the future. (not implemented yet)

save

public java.lang.String save(java.lang.String dir)

this method will save the content of this object to the specified file