edu.vt.marian.uip
Class parameter

java.lang.Object
  |
  +--edu.vt.marian.uip.parameter

public class parameter

extends java.lang.Object

class name: parameter class description: this class implement parameter related operations uses the services of class(es): xdr designer: Junni Fan (jfan@vt.edu) implementators: Junni Fan(jfan@vt.edu) finished time: 11/29/98 known bugs: JDK version: 1.1.6 side effects:

Field Summary

static int	CANNOT_HANDLE
static int	ERROR
static int	ERROR_IO
static int	INVALID_PARAMETER
static int	OK
static int	PROCESS_ERROR

Constructor Summary

parameter(java.io.BufferedInputStream bis, int version, edu.vt.marian.common.Debug debug)
method description: parameter constructor, create a parameter object from a stream uses the services of class(es): none input parameter(s): debug -- only for debugging bis -- input stream version -- now can only handle version 2 output parameter(s): none return value: none synchronization consideration: none

parameter(java.lang.String name, java.lang.String type, java.lang.Object value, edu.vt.marian.common.Debug debug)
method description: parameter constructor uses the services of class(es): none input parameter(s): debug -- only for debugging name -- parameter name type -- parameter type value -- parameter value output parameter(s): none return value: none synchronization consideration: none

Method Summary

java.lang.String	get_name() method description: return name of this parameter uses the services of class(es): none input parameter(s): none output parameter(s): none return value: this parameter's name synchronization consideration: none
int	get_size_in_xdr() method description: caculate size in xdr uses the services of class(es): xdr input parameter(s): none output parameter(s): none return value: this parameter's size in xdr synchronization consideration: none
java.lang.String	get_type() method description: get type uses the services of class(es): none input parameter(s): none output parameter(s): none return value: this parameter's type synchronization consideration: none
java.lang.Object	get_value() method description: get value uses the services of class(es): none input parameter(s): none output parameter(s): none return value: this parameter's value synchronization consideration: none
boolean	is_valid() method description: tell whether or not this object is a valid parameter uses the services of class(es): none input parameter(s): none output parameter(s): none return value: true -- this is a valid parameter false -- this is not a valid parameter synchronization consideration: none
java.util.Vector	read_doc_id_vect_from_stream_in_xdr(java.io.BufferedInputStream bis) method description: read a doc_id_vect from the input stream uses the services of class(es): xdr input parameter(s): bis -- input stream output parameter(s): none return value: the desired doc_id_vect, null if error occurred synchronization consideration: none
java.util.Vector	read_doc_vect_from_stream_in_xdr(java.io.BufferedInputStream bis) method description: read a doc_vect from the input stream uses the services of class(es): xdr input parameter(s): bis -- input stream output parameter(s): none return value: the desired doc_vect, null if error occurred synchronization consideration: none
java.util.Vector	read_obj_vect_from_stream_in_xdr(java.io.BufferedInputStream bis) method description: read an object_vect from the input stream uses the services of class(es): xdr input parameter(s): bis -- input stream output parameter(s): none return value: the desired object_vect, null if error occurred synchronization consideration: none
java.util.Vector	read_raw_doc_vect_from_stream_in_xdr(java.io.BufferedInputStream bis) method description: read a raw_doc_vect from the input stream uses the services of class(es): xdr input parameter(s): bis -- input stream output parameter(s): none return value: the desired raw_doc_vect, null if error occurred synchronization consideration: none
int	to_stream_in_xdr(int version, java.io.BufferedOutputStream bos) method description: write this parameter to the output stream uses the services of class(es): xdr input parameter(s): version -- different version has different format 1 -- only write out value 2 -- name, type and value bos -- output stream output parameter(s): none return value: OK -- success INVALID_PARAMETER -- parameter is wrong ERROR_IO -- wrong in IO operation PROCESS_ERROR -- wrong when call other classes' method synchronization consideration: none note: flush is not done here to save time, any class use this method must take care of flush.
int	to_stream(int detail_level, java.io.PrintWriter pw) method description: write this parameter to pw uses the services of class(es): xdr input parameter(s): detail_level -- how much will be written out pw -- output writer output parameter(s): none return value: OK -- success INVALID_PARAMETER -- parameter is wrong ERROR_IO -- wrong in IO operation synchronization consideration: none note: flush is not done here to save time, any class use this method must take care of flush.

Methods inherited from class java.lang.Object

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

Field Detail

OK

public static final int OK

ERROR

public static final int ERROR

INVALID_PARAMETER

public static final int INVALID_PARAMETER

ERROR_IO

public static final int ERROR_IO

CANNOT_HANDLE

public static final int CANNOT_HANDLE

PROCESS_ERROR

public static final int PROCESS_ERROR

Constructor Detail

parameter

public parameter(java.lang.String name,
                 java.lang.String type,
                 java.lang.Object value,
                 edu.vt.marian.common.Debug debug)

method description: parameter constructor uses the services of class(es): none input parameter(s): debug -- only for debugging name -- parameter name type -- parameter type value -- parameter value output parameter(s): none return value: none synchronization consideration: none

parameter

public parameter(java.io.BufferedInputStream bis,
                 int version,
                 edu.vt.marian.common.Debug debug)

method description: parameter constructor, create a parameter object from a stream uses the services of class(es): none input parameter(s): debug -- only for debugging bis -- input stream version -- now can only handle version 2 output parameter(s): none return value: none synchronization consideration: none

Method Detail

get_name

public java.lang.String get_name()

method description: return name of this parameter uses the services of class(es): none input parameter(s): none output parameter(s): none return value: this parameter's name synchronization consideration: none

get_size_in_xdr

public int get_size_in_xdr()

method description: caculate size in xdr uses the services of class(es): xdr input parameter(s): none output parameter(s): none return value: this parameter's size in xdr synchronization consideration: none

get_type

public java.lang.String get_type()

method description: get type uses the services of class(es): none input parameter(s): none output parameter(s): none return value: this parameter's type synchronization consideration: none

get_value

public java.lang.Object get_value()

method description: get value uses the services of class(es): none input parameter(s): none output parameter(s): none return value: this parameter's value synchronization consideration: none

to_stream_in_xdr

public int to_stream_in_xdr(int version,
                            java.io.BufferedOutputStream bos)

method description: write this parameter to the output stream uses the services of class(es): xdr input parameter(s): version -- different version has different format 1 -- only write out value 2 -- name, type and value bos -- output stream output parameter(s): none return value: OK -- success INVALID_PARAMETER -- parameter is wrong ERROR_IO -- wrong in IO operation PROCESS_ERROR -- wrong when call other classes' method synchronization consideration: none note: flush is not done here to save time, any class use this method must take care of flush.

to_stream

public int to_stream(int detail_level,
                     java.io.PrintWriter pw)

method description: write this parameter to pw uses the services of class(es): xdr input parameter(s): detail_level -- how much will be written out pw -- output writer output parameter(s): none return value: OK -- success INVALID_PARAMETER -- parameter is wrong ERROR_IO -- wrong in IO operation synchronization consideration: none note: flush is not done here to save time, any class use this method must take care of flush.

read_obj_vect_from_stream_in_xdr

public java.util.Vector read_obj_vect_from_stream_in_xdr(java.io.BufferedInputStream bis)

method description: read an object_vect from the input stream uses the services of class(es): xdr input parameter(s): bis -- input stream output parameter(s): none return value: the desired object_vect, null if error occurred synchronization consideration: none

read_doc_vect_from_stream_in_xdr

public java.util.Vector read_doc_vect_from_stream_in_xdr(java.io.BufferedInputStream bis)

method description: read a doc_vect from the input stream uses the services of class(es): xdr input parameter(s): bis -- input stream output parameter(s): none return value: the desired doc_vect, null if error occurred synchronization consideration: none

read_raw_doc_vect_from_stream_in_xdr

public java.util.Vector read_raw_doc_vect_from_stream_in_xdr(java.io.BufferedInputStream bis)

method description: read a raw_doc_vect from the input stream uses the services of class(es): xdr input parameter(s): bis -- input stream output parameter(s): none return value: the desired raw_doc_vect, null if error occurred synchronization consideration: none

read_doc_id_vect_from_stream_in_xdr

public java.util.Vector read_doc_id_vect_from_stream_in_xdr(java.io.BufferedInputStream bis)

method description: read a doc_id_vect from the input stream uses the services of class(es): xdr input parameter(s): bis -- input stream output parameter(s): none return value: the desired doc_id_vect, null if error occurred synchronization consideration: none

is_valid

public boolean is_valid()

method description: tell whether or not this object is a valid parameter uses the services of class(es): none input parameter(s): none output parameter(s): none return value: true -- this is a valid parameter false -- this is not a valid parameter synchronization consideration: none