com.sptci.jpa
Class StartLetter

java.lang.Object
  com.sptci.jpa.JPAObject
      com.sptci.jpa.StartLetter

All Implemented Interfaces:

Serializable, Cloneable, Comparable<JPAObject>

public class StartLetter
extends JPAObject

A simple object that is used to implement efficient alphabetical indexing of persistent objects. Querying instances of this object can return the starting characters for the associated object very efficiently instead of running through the extent for the object instances.

© Copyright 2007, Sans Pareil Technologies, Inc.

Version:

$Id: StartLetter.java 4553 2008-12-24 10:34:16Z rakesh $

Author:

Rakesh Vidyadharan 2007-05-25

See Also:

Serialized Form

Field Summary

protected char	letter The start letter that is represented by this instance.
protected String	source The discriminator field that is used to qualify the source object with which this instance is associated.

Fields inherited from class com.sptci.jpa.JPAObject

hash, HASH, logger, oid, startLetter

Constructor Summary

protected	StartLetter() Default constructor.
	StartLetter(char letter, String source) Create a new instance of the object with the specified values.

Method Summary

char	getLetter() Returns letter.
String	getSource() Returns source.

Methods inherited from class com.sptci.jpa.JPAObject

clone, compareTo, createXStream, equals, fromXML, getObjectId, getStartLetter, hashCode, jdoPostLoad, jdoPreDelete, jdoPreStore, resetHash, toString, toXML

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

letter

protected char letter

The start letter that is represented by this instance.

source

protected String source

The discriminator field that is used to qualify the source object with which this instance is associated.

Constructor Detail

StartLetter

protected StartLetter()

Default constructor. Do not use. Only for JPA compliance.

StartLetter

public StartLetter(char letter,
                   String source)

Create a new instance of the object with the specified values.

Method Detail

getLetter

public char getLetter()

Returns letter.

Returns:

The value/reference of/to letter.

getSource

public String getSource()

Returns source.

Returns:

The value/reference of/to source.