stanford.netdb

Class Person

java.lang.Object

stanford.netdb.logging.NetDB_Logger

stanford.netdb.Attribute<T>

stanford.netdb.NetDB<T>

stanford.netdb.Record<Person>

stanford.netdb.Person

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<Person>, java.util.Comparator<Person>

Direct Known Subclasses:

Consultant, Directory_Person

public class Person
extends Record<Person>

This class should be a "final" class, but isn't, so inheritance with Consultants will work as needed. Do not extend this class if you use the RMI service. If you do, you will get an unmarshalling error when attempting to interact with the RMI server. This is both expected, and the correct behavior.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Person.COMPARE_TYPE

Nested classes/interfaces inherited from class stanford.netdb.NetDB

NetDB.FORMAT

Nested classes/interfaces inherited from class stanford.netdb.Attribute

Attribute.COMPARISON_TYPE

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	JSON_ACTIVE
static java.lang.String	JSON_DIR_ACTIVE
static java.lang.String	JSON_DIRID
static java.lang.String	JSON_EMAIL
static java.lang.String	JSON_LAST_NAME
static java.lang.String	JSON_NAME
static java.lang.String	JSON_NETID
static java.lang.String	JSON_PHONE
static java.lang.String	JSON_REGID
static java.lang.String	json_template_name The template toJSON uses.
static java.util.Comparator<Person>	name_comparator Person records are compared in ascending order of last name, full name - first last, and netid.
static java.util.Comparator<Person>	regid_comparator Person records are compared in ascending order of their registry ID.
static java.lang.String	template_name The template toString uses.

Fields inherited from class stanford.netdb.NetDB

extra_data, UNPROCESSED_JSON

Constructor Summary

Constructors

Constructor and Description
Person()

Method Summary

Modifier and Type	Method and Description
Person	_insert_or_update(java.lang.String transaction_name, NetDB_Datastore datastore) This method makes the DB call(s).
static java.util.Hashtable	_load_object(java.lang.String transaction_name, NetDB_Datastore datastore, java.lang.Long id, java.lang.String handle) This method makes the DB call(s).
static java.lang.Long	_verify_or_die(java.lang.String transaction_name, NetDB_Datastore datastore, java.lang.Long id, java.lang.String handle)
java.lang.Boolean	active() Fetch the active state.
Person	commit(NetDB_Datastore datastore) This class cannot currently be committed.
int	compare(Person person_1, Person person_2)
int	compare(Person person_1, Person person_2, Person.COMPARE_TYPE type)
int	compareTo(Person that) Compare two objects based on their handles (case blind).
void	delete(NetDB_Datastore datastore) This class cannot currently be deleted.
static void	delete(NetDB_Datastore datastore, java.lang.String handle) This class cannot currently be deleted.
static void	delete(java.lang.String handle) This class cannot currently be deleted.
java.lang.String	dir_id() Fetch the directory ID.
java.lang.String	dirID() Alias for dir_id ().
java.lang.String	email() Fetch the email address.
java.lang.String	handle() This is the unique identifier used in the database to identify a record.
java.lang.Long	id() Fetch the ID.
java.lang.String	last_name() Fetch the last name.
java.lang.String	lastname() Alias for last_name (...).
static Person	load(java.lang.Long id) Load id from the default datastore.
static Person	load(NetDB_Datastore datastore, java.lang.Long id) Load handle from the specified datastore.
static Person	load(NetDB_Datastore datastore, java.lang.String handle) Load handle from the specified datastore.
static Person	load(java.lang.String handle) Load handle from the default datastore.
java.lang.String	name() Fetch the name.
java.lang.String	netid() Fetch the netid.
java.lang.String	netID() Alias for netid ().
Person	new_instance() Create a new instance of this class's type.
java.lang.String	phone() Fetch the phone number.
java.lang.String	reg_id() Fetch the registry ID.
java.lang.String	regID() Alias for reg_id ().
java.lang.String	single_value_attributes() This method builds a String of all the single value attributes.
java.util.Comparator<Person>	sort_comparator() Attributes may define their own comparator to be used when sorting.
java.lang.String	toJSON(java.lang.Boolean pretty, java.lang.Boolean ignore_exceptions) Convert this to a JSON object using the template defined in json_template_name.
java.lang.String	toString(NetDB.FORMAT format, java.lang.Boolean ignore_exceptions) Convert this to a String using the template defined in template_name.
Person	unlink() Treat this object as user created, and clear any datastore specific information.

Methods inherited from class stanford.netdb.Record

commit, delete

Methods inherited from class stanford.netdb.NetDB

autocomplete, autocomplete, bind, clear_extra_data, compare, compare, complete, created_by_user, datastore, default_datastore, default_datastore, defined_or_die_handle, defined_or_die, equals, extra_data, extra_data, extra_data, fromJSON, is_bound, is_complete, is_partial, json_recovery_log, reset_timing, rmi_exception, timing, toJSON, toJSON, toJSON, toJSON, toString, toString, toString, toString, unbind, unique_identifier, version

Methods inherited from class stanford.netdb.logging.NetDB_Logger

backup_logger, backup_logger, default_logger, default_logger, entered, entered, entered, exited, exited, exited, get_method_name, log_enter_exit, log_message, logger, logger

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Comparator

comparing, comparing, comparingDouble, comparingInt, comparingLong, naturalOrder, nullsFirst, nullsLast, reversed, reverseOrder, thenComparing, thenComparing, thenComparing, thenComparingDouble, thenComparingInt, thenComparingLong

Field Detail

template_name

public static java.lang.String template_name

The template toString uses.

json_template_name

public static java.lang.String json_template_name

The template toJSON uses.

JSON_NETID

public static final java.lang.String JSON_NETID

See Also:

Constant Field Values

JSON_NAME

public static final java.lang.String JSON_NAME

See Also:

Constant Field Values

JSON_LAST_NAME

public static final java.lang.String JSON_LAST_NAME

See Also:

Constant Field Values

JSON_DIRID

public static final java.lang.String JSON_DIRID

See Also:

Constant Field Values

JSON_REGID

public static final java.lang.String JSON_REGID

See Also:

Constant Field Values

JSON_PHONE

public static final java.lang.String JSON_PHONE

See Also:

Constant Field Values

JSON_EMAIL

public static final java.lang.String JSON_EMAIL

See Also:

Constant Field Values

JSON_DIR_ACTIVE

public static final java.lang.String JSON_DIR_ACTIVE

See Also:

Constant Field Values

JSON_ACTIVE

public static final java.lang.String JSON_ACTIVE

See Also:

Constant Field Values

name_comparator

public static java.util.Comparator<Person> name_comparator

Person records are compared in ascending order of last name, full name - first last, and netid.

regid_comparator

public static java.util.Comparator<Person> regid_comparator

Person records are compared in ascending order of their registry ID.

Constructor Detail

Person

public Person()

Method Detail

id

public java.lang.Long id()
                  throws java.lang.Exception,
                         No_Datastore_Defined,
                         Insufficient_Information

Fetch the ID. If it is not present, attempt to fetch it from the database.

Throws:

java.lang.Exception

No_Datastore_Defined

Insufficient_Information

regID

public java.lang.String regID()
                       throws java.lang.Exception,
                              No_Datastore_Defined,
                              Insufficient_Information

Alias for reg_id ().

Throws:

java.lang.Exception

No_Datastore_Defined

Insufficient_Information

reg_id

public java.lang.String reg_id()
                        throws java.lang.Exception,
                               No_Datastore_Defined,
                               Insufficient_Information

Fetch the registry ID. If it is not present, and this instance is capable of being autocompleted, then this instance will be loaded and the value returned.

Throws:

java.lang.Exception

No_Datastore_Defined

Insufficient_Information

See Also:

NetDB.internal_complete(java.lang.Object, java.lang.Object, java.lang.String)

name

public java.lang.String name()
                      throws java.lang.Exception,
                             No_Datastore_Defined,
                             Insufficient_Information

Fetch the name. If it is not present, and this instance is capable of being autocompleted, then this instance will be loaded and the value returned.

Throws:

java.lang.Exception

No_Datastore_Defined

Insufficient_Information

See Also:

NetDB.internal_complete(java.lang.Object, java.lang.Object, java.lang.String)

netID

public java.lang.String netID()
                       throws java.lang.Exception,
                              No_Datastore_Defined,
                              Insufficient_Information

Alias for netid ().

Throws:

java.lang.Exception

No_Datastore_Defined

Insufficient_Information

netid

public java.lang.String netid()
                       throws java.lang.Exception,
                              No_Datastore_Defined,
                              Insufficient_Information

Fetch the netid. If it is not present, and this instance is capable of being autocompleted, then this instance will be loaded and the value returned.

Throws:

java.lang.Exception

No_Datastore_Defined

Insufficient_Information

See Also:

NetDB.internal_complete(java.lang.Object, java.lang.Object, java.lang.String)

email

public java.lang.String email()
                       throws java.lang.Exception,
                              No_Datastore_Defined,
                              Insufficient_Information

Fetch the email address. If it is not present, and this instance is capable of being autocompleted, then this instance will be loaded and the value returned.

Throws:

java.lang.Exception

No_Datastore_Defined

Insufficient_Information

See Also:

NetDB.internal_complete(java.lang.Object, java.lang.Object, java.lang.String)

phone

public java.lang.String phone()
                       throws java.lang.Exception,
                              No_Datastore_Defined,
                              Insufficient_Information

Fetch the phone number. If it is not present, and this instance is capable of being autocompleted, then this instance will be loaded and the value returned.

Throws:

java.lang.Exception

No_Datastore_Defined

Insufficient_Information

See Also:

NetDB.internal_complete(java.lang.Object, java.lang.Object, java.lang.String)

active

public java.lang.Boolean active()
                         throws java.lang.Exception,
                                No_Datastore_Defined,
                                Insufficient_Information

Fetch the active state. A person is considered to be active if they are currently affiliated with Stanford. If it is not present, and this instance is capable of being autocompleted, then this instance will be loaded and the value returned.

Throws:

java.lang.Exception

No_Datastore_Defined

Insufficient_Information

See Also:

NetDB.internal_complete(java.lang.Object, java.lang.Object, java.lang.String)

lastname

public java.lang.String lastname()
                          throws java.lang.Exception,
                                 No_Datastore_Defined,
                                 Insufficient_Information

Alias for last_name (...).

Throws:

java.lang.Exception

No_Datastore_Defined

Insufficient_Information

last_name

public java.lang.String last_name()
                           throws java.lang.Exception,
                                  No_Datastore_Defined,
                                  Insufficient_Information

Fetch the last name. If it is not present, and this instance is capable of being autocompleted, then this instance will be loaded and the value returned.

Throws:

java.lang.Exception

No_Datastore_Defined

Insufficient_Information

See Also:

NetDB.internal_complete(java.lang.Object, java.lang.Object, java.lang.String)

dirID

public java.lang.String dirID()
                       throws java.lang.Exception,
                              No_Datastore_Defined,
                              Insufficient_Information

Alias for dir_id ().

Throws:

java.lang.Exception

No_Datastore_Defined

Insufficient_Information

dir_id

public java.lang.String dir_id()
                        throws java.lang.Exception,
                               No_Datastore_Defined,
                               Insufficient_Information

Fetch the directory ID. If it is not present, and this instance is capable of being autocompleted, then this instance will be loaded and the value returned.

Throws:

java.lang.Exception

No_Datastore_Defined

Insufficient_Information

See Also:

NetDB.internal_complete(java.lang.Object, java.lang.Object, java.lang.String)

handle

public java.lang.String handle()

Description copied from class: NetDB

This is the unique identifier used in the database to identify a record. Most of the time this is the "name" of the record.

Specified by:

handle in class NetDB<Person>

new_instance

public Person new_instance()
                    throws java.lang.Exception

Description copied from class: NetDB

Create a new instance of this class's type.

Specified by:

new_instance in class NetDB<Person>

Throws:

java.lang.Exception

unlink

public Person unlink()

Description copied from class: NetDB

Treat this object as user created, and clear any datastore specific information. The datastore is NOT cleared.

Overrides:

unlink in class NetDB<Person>

single_value_attributes

public java.lang.String single_value_attributes()

Description copied from class: Attribute

This method builds a String of all the single value attributes. The resulting String is used in compare (...) and is not meant to be parsed by users of this library.

Specified by:

single_value_attributes in class Attribute<Person>

See Also:

Attribute.compare(Attribute), Attribute.compare(Attribute,COMPARISON_TYPE)

toString

public java.lang.String toString(NetDB.FORMAT format,
                                 java.lang.Boolean ignore_exceptions)
                          throws java.lang.Exception

Convert this to a String using the template defined in template_name.

Specified by:

toString in class NetDB<Person>

Throws:

java.lang.Exception

toJSON

public java.lang.String toJSON(java.lang.Boolean pretty,
                               java.lang.Boolean ignore_exceptions)
                        throws java.lang.Exception

Convert this to a JSON object using the template defined in json_template_name.

Specified by:

toJSON in class NetDB<Person>

Throws:

java.lang.Exception

sort_comparator

public java.util.Comparator<Person> sort_comparator()

Description copied from class: Attribute

Attributes may define their own comparator to be used when sorting. If a comparator isn't explicitly defined, "unique_identifier" will be used as the sort key.

Overrides:

sort_comparator in class Attribute<Person>

compareTo

public int compareTo(Person that)

Description copied from class: NetDB

Compare two objects based on their handles (case blind).

Specified by:

compareTo in interface java.lang.Comparable<Person>

Overrides:

compareTo in class NetDB<Person>

Returns:

-1 this < that

compare

public int compare(Person person_1,
                   Person person_2)

Specified by:

compare in interface java.util.Comparator<Person>

Overrides:

compare in class NetDB<Person>

compare

public int compare(Person person_1,
                   Person person_2,
                   Person.COMPARE_TYPE type)

_verify_or_die

public static java.lang.Long _verify_or_die(java.lang.String transaction_name,
                                            NetDB_Datastore datastore,
                                            java.lang.Long id,
                                            java.lang.String handle)
                                     throws java.lang.Exception

Throws:

java.lang.Exception

load

public static Person load(java.lang.String handle)
                   throws java.lang.Exception,
                          No_Datastore_Defined,
                          Insufficient_Information,
                          Record_Not_Found

Load handle from the default datastore.

Throws:

java.lang.Exception

No_Datastore_Defined

Insufficient_Information

Record_Not_Found

load

public static Person load(java.lang.Long id)
                   throws java.lang.Exception,
                          No_Datastore_Defined,
                          Insufficient_Information,
                          Record_Not_Found

Load id from the default datastore.

Throws:

java.lang.Exception

No_Datastore_Defined

Insufficient_Information

Record_Not_Found

load

public static Person load(NetDB_Datastore datastore,
                          java.lang.String handle)
                   throws java.lang.Exception,
                          No_Datastore_Defined,
                          Insufficient_Information,
                          Record_Not_Found

Load handle from the specified datastore.

Throws:

java.lang.Exception

No_Datastore_Defined

Insufficient_Information

Record_Not_Found

load

public static Person load(NetDB_Datastore datastore,
                          java.lang.Long id)
                   throws java.lang.Exception,
                          No_Datastore_Defined,
                          Insufficient_Information,
                          Record_Not_Found

Load handle from the specified datastore.

Throws:

java.lang.Exception

No_Datastore_Defined

Insufficient_Information

Record_Not_Found

_load_object

public static java.util.Hashtable _load_object(java.lang.String transaction_name,
                                               NetDB_Datastore datastore,
                                               java.lang.Long id,
                                               java.lang.String handle)
                                        throws java.lang.Exception

This method makes the DB call(s). The method(s), with a similar name, will either contact an RMI server, or call this method directly. Calling this method with an RMI datastore will result in an error.

Throws:

java.lang.Exception

delete

public void delete(NetDB_Datastore datastore)
            throws Not_Implemented

This class cannot currently be deleted. This will always throw a Not_Implemented exception.

Specified by:

delete in class Record<Person>

Throws:

Not_Implemented

delete

public static void delete(java.lang.String handle)
                   throws Not_Implemented

This class cannot currently be deleted. This will always throw a Not_Implemented exception.

Throws:

Not_Implemented

delete

public static void delete(NetDB_Datastore datastore,
                          java.lang.String handle)
                   throws Not_Implemented

This class cannot currently be deleted. This will always throw a Not_Implemented exception.

Throws:

Not_Implemented

commit

public Person commit(NetDB_Datastore datastore)
              throws Not_Implemented

This class cannot currently be committed. This will always throw a Not_Implemented exception.

Specified by:

commit in class Record<Person>

Throws:

Not_Implemented

_insert_or_update

public Person _insert_or_update(java.lang.String transaction_name,
                                NetDB_Datastore datastore)
                         throws java.lang.Exception

This method makes the DB call(s). The method(s), with a similar name, will either contact an RMI server, or call this method directly. Calling this method with an RMI datastore will result in an error.

Throws:

java.lang.Exception