A B C D E F G H I L M N O P Q R S T U V W X

A

addCloseTag(StringBuffer, String, int) - Static method in class mls.common.TranslatingXmlObject
Add close tag to an initialized document
addOpenTag(StringBuffer, String, int) - Static method in class mls.common.TranslatingXmlObject
Add open tag to an initialized document
address - Variable in class mls.domain.Property
 
Address - class mls.domain.Address.
A property address
Address() - Constructor for class mls.domain.Address
Default constructor
addString(StringBuffer, String, int) - Static method in class mls.common.TranslatingXmlObject
Add a string element using level to determine indenting Do not add tags as these are assumed to exist Note this is only used by buildEnum
addString(StringBuffer, String, String, int) - Static method in class mls.common.TranslatingXmlObject
Add a string element with CDATA quoting to an initialized document Use level to determine indenting
age - Variable in class mls.domain.Property
 
ANY - Static variable in class mls.domain.Property
Used where any value will do
area - Variable in class mls.domain.Lot
The land area in square meters

B

BAD_OPERATION - Static variable in class mls.common.Errors
 
bathrooms - Variable in class mls.domain.Property
 
bedrooms - Variable in class mls.domain.Property
 
build(StringBuffer, Object, int) - Static method in class mls.common.TranslatingXmlObject
Build XML document from the specified object This routine is recursive to handle nesting; the recursion terminates primitive elements (or strings) are encountered level specifies indentation within the XML document
buildArrayPrimitive(StringBuffer, Object, int, Class, int) - Static method in class mls.common.TranslatingXmlObject
Build a primitive element from an item in an array
buildEnum(StringBuffer, Object, Class, int) - Static method in class mls.common.TranslatingXmlObject
Build an enumerated type XML string
buildPrimitive(StringBuffer, Object, Field, Class, int) - Static method in class mls.common.TranslatingXmlObject
Build a primitive element from the field in an object

C

CACHE - Static variable in class mls.view.Viewer
 
city - Variable in class mls.domain.Address
The city
classNameToXmlTag(String) - Static method in class mls.common.TranslatingXmlObject
Convert a class name to an xml tag name
Config - class mls.common.Config.
All frequently changed configuration values.
Config() - Constructor for class mls.common.Config
 

D

DEFAULT_RESULTS_PER_PAGE - Static variable in class mls.common.Config
 
destroy() - Method in class mls.controller.HttpServlet
Release all resources held by the servlet
dimensions - Variable in class mls.domain.Property
 
doGet(HttpServletRequest, HttpServletResponse) - Method in class mls.controller.HttpServlet
Parse out the operation and call the appropriate method.
doPost(HttpServletRequest, HttpServletResponse) - Method in class mls.controller.HttpServlet
Process POST operations, just a wrapper around doGet
doQuery(HttpServletRequest, HttpServletResponse, Viewer) - Method in class mls.controller.Workflow
Operation method to do a query.
doQuery(Query) - Static method in class mls.domain.MlsBusinessObject
Process the specified query, returning a results object Currently, this retrieves results from an XML file as opposed to a database.
dump(Document) - Static method in class mls.common.XmlObject
Dump the specified XML document to a string
dumpElement(Element, int) - Static method in class mls.common.XmlObject
Dump a single element at the specified indent level

E

EMPTY - Static variable in class mls.common.TranslatingXmlObject
 
EMPTY_STRING - Static variable in class mls.controller.Workflow
 
ERROR - Static variable in class mls.view.Viewer
 
ERROR_DOING_QUERY - Static variable in class mls.common.Errors
 
ERROR_FETCHING_NEXT - Static variable in class mls.common.Errors
 
ERROR_IN_QUERY_PARAMS - Static variable in class mls.common.Errors
 
ERROR_MAKING_QUERY - Static variable in class mls.common.Errors
 
ERROR_PERFORMING_OP - Static variable in class mls.common.Errors
 
Errors - class mls.common.Errors.
Error message string constants
Errors() - Constructor for class mls.common.Errors
 
extract(Class, Element) - Static method in class mls.common.TranslatingXmlObject
Extract an instance of the specified class from the supplied DOM element This routine is recursive to handle nesting; the recursion terminates when primitive elements (or strings) are encountered
extractArrayPrimitive(Object, int, Class, Element) - Static method in class mls.common.TranslatingXmlObject
Extract a primitive element's value and populate the indexed item in an array
extractEnum(Class, Element) - Static method in class mls.common.TranslatingXmlObject
Extract a value for an enumerated type
extractPrimitive(Object, Field, Class, Element) - Static method in class mls.common.TranslatingXmlObject
Extract a primitive element's values and populate a field in an object

F

fetchNext(HttpServletRequest, HttpServletResponse, Viewer) - Method in class mls.controller.Workflow
Operation method to fetch a partial results set from a previous query.
filterResults(Results, Query) - Static method in class mls.domain.MlsBusinessObject
Filter a results set based on the specified query

G

getChildren(Document, String) - Static method in class mls.common.XmlObject
Return child elements of a document with specified tag name
getChildren(Element, String) - Static method in class mls.common.XmlObject
Return child elements of an element with specified tag name
getElement(Document, String) - Static method in class mls.common.XmlObject
Return the first element matching the elTagName in a document
getElement(Element, String) - Static method in class mls.common.XmlObject
Return the first element matching the elTagName in an element
getElement(Element, String, int) - Static method in class mls.common.XmlObject
Return the nth element matching the elTagName in an element
getElementText(Element) - Static method in class mls.common.XmlObject
Return the specified element's text
getNewResultsPerPage(HttpServletRequest) - Method in class mls.controller.Workflow
Get the specified or default results to be displayed on a page.
getParser() - Static method in class mls.common.XmlObject
Common routine to get a DOM parser
getQuery(HttpServletRequest, HttpServletResponse, Viewer) - Method in class mls.controller.Workflow
Operation method to display a query entry page
getSavedResultsPerPage(HttpServletRequest) - Method in class mls.controller.Workflow
Get the previously saved number of results to be displayed on a page.
getSubset(int, int) - Method in class mls.domain.Results
Return a subset of the properties beginning at 'start' and of length 'length'.
getTest() - Static method in class mls.domain.Address
Get a 'filled-in' address for testing
getTest() - Static method in class mls.domain.Lot
Get a 'filled-in' lot for testing
getTest() - Static method in class mls.domain.Property
Get a 'filled-in' property for testing, including nested address and lot objects
getTest() - Static method in class mls.domain.Results
Return a test results set

H

HTML_PROLOGUE - Static variable in class mls.common.Config
 
HTML_TEMPLATE_DIR - Static variable in class mls.common.Config
 
htmlViewer - Variable in class mls.controller.HttpServlet
Template processing HTML viewer
HtmlViewer - class mls.view.HtmlViewer.
An XML/XSLT based viewer that processes XML data and XSL page templates to generate HTML markup
HtmlViewer() - Constructor for class mls.view.HtmlViewer
Default constructor
HttpServlet - class mls.controller.HttpServlet.
MLS servlet - processes Multiple Listing Service operations (see doGet() for supported operations).
HttpServlet() - Constructor for class mls.controller.HttpServlet
 

I

id - Variable in class mls.domain.Property
 
INDENT - Static variable in class mls.common.XmlObject
Used in XML string creation and printing
indent(int) - Static method in class mls.common.XmlObject
Return an indentation string based on level
init() - Method in class mls.controller.HttpServlet
Create viewers, workflow, and MLS business object
initDoc() - Static method in class mls.common.TranslatingXmlObject
Initialize a document as a standalone document
isPrimitive(Class) - Static method in class mls.common.TranslatingXmlObject
Return true if this is a Java primitive or String class
isValid() - Method in class mls.domain.Query
Returns true if this query structure has been correctly initialized.
isWapUser(HttpServletRequest) - Method in class mls.controller.HttpServlet
Return true if this request is from a WAP user agent

L

LAST_RESULTS - Static variable in class mls.controller.Workflow
Label used to cache results for a session
lot - Variable in class mls.domain.Property
 
Lot - class mls.domain.Lot.
A property lot
Lot() - Constructor for class mls.domain.Lot
Default constructor

M

MAX_RESULTS_PER_PAGE - Static variable in class mls.controller.Workflow
 
maxPrice - Variable in class mls.domain.Query
 
MERGE_ERROR - Static variable in class mls.common.Errors
 
merge(Document, Document, PrintWriter) - Method in class mls.view.Viewer
Generate XML from the specified XML data and XSL stylesheet
merge(Object, String, PrintWriter) - Method in class mls.view.Viewer
Generate XML from the specified data and XSL stylesheet
merge(String, String, PrintWriter) - Method in class mls.view.Viewer
Generate XML from the specified xml data and XSL stylesheet
MIN_RESULTS_PER_PAGE - Static variable in class mls.controller.Workflow
 
minPrice - Variable in class mls.domain.Query
Minimum and maximum price for desired property
mlsBO - Variable in class mls.controller.HttpServlet
MLS business object to access MLS data and business rules Should be implemented as EJB eventually, for scalability
MlsBusinessObject - class mls.domain.MlsBusinessObject.
A business object that wrappers access to the multiple listing service database.
MlsBusinessObject() - Constructor for class mls.domain.MlsBusinessObject
 
more - Variable in class mls.domain.Results
True if there are more results in the parent results set

N

narrow(NodeList, Node) - Static method in class mls.common.XmlObject
Narrow descendents node list to the child elements
nElements(Element, String) - Static method in class mls.common.XmlObject
Return a count of all elements under element matching the tag
nextID() - Static method in class mls.domain.Property
Test method to return unique MLS ID
NO_CACHE - Static variable in class mls.view.Viewer
 
NO_PRICE_LIMIT - Static variable in class mls.domain.Property
A rough approximation to an infinite price
NOT_SET - Static variable in class mls.domain.Property
 
NULL_BOOLEAN - Static variable in class mls.common.TranslatingXmlObject
 
NULL_BYTE - Static variable in class mls.common.TranslatingXmlObject
 
NULL_CHAR - Static variable in class mls.common.TranslatingXmlObject
 
NULL_DOUBLE - Static variable in class mls.common.TranslatingXmlObject
 
NULL_FLOAT - Static variable in class mls.common.TranslatingXmlObject
 
NULL_INTEGER - Static variable in class mls.common.TranslatingXmlObject
 
NULL_LONG - Static variable in class mls.common.TranslatingXmlObject
 
NULL_SHORT - Static variable in class mls.common.TranslatingXmlObject
 
NULL_STRING - Static variable in class mls.common.TranslatingXmlObject
 

O

object2Xml(Object) - Static method in class mls.common.TranslatingXmlObject
Build an xml document string from the specified object
OPERATION - Static variable in class mls.controller.HttpServlet
Operation parameter name

P

parse(String) - Static method in class mls.common.XmlObject
Create a DOM document structure from the specified XML file
parseString(String) - Static method in class mls.common.XmlObject
Create a DOM document structure from the specified XML string
postalCode - Variable in class mls.domain.Address
The postal or zip code
price - Variable in class mls.domain.Property
 
printPrologue(PrintWriter) - Method in class mls.view.HtmlViewer
Print an HTML document prologue
printPrologue(PrintWriter) - Method in class mls.view.Viewer
Print a document prologue - Implemented by child class
printPrologue(PrintWriter) - Method in class mls.view.WmlViewer
Print a WML document prologue
properties - Variable in class mls.domain.Results
The set of property results
Property - class mls.domain.Property.
A piece of real property (e.g.
Property() - Constructor for class mls.domain.Property
Default constructor
provOrState - Variable in class mls.domain.Address
The province or state

Q

Query - class mls.domain.Query.
MLS query structure
QUERY_CLASS - Static variable in class mls.controller.Workflow
 
QUERY_PAGE - Static variable in class mls.controller.Workflow
 
Query() - Constructor for class mls.domain.Query
Default constructor

R

Results - class mls.domain.Results.
The results of an MLS query.
RESULTS_CLASS - Static variable in class mls.controller.Workflow
 
RESULTS_PAGE - Static variable in class mls.controller.Workflow
 
RESULTS_PER_PAGE - Static variable in class mls.controller.Workflow
 
Results() - Constructor for class mls.domain.Results
Default constructor

S

setCache(String, HttpServletResponse) - Method in class mls.view.Viewer
Set general cache headers based on cachePage flag
setCache(String, HttpServletResponse) - Method in class mls.view.WmlViewer
Set cache headers based on cachePage flag Overrides the super class method, adding a WAP header
setMaxPrice(String) - Method in class mls.domain.Query
Set the maximum price from a string.
setMinPrice(String) - Method in class mls.domain.Query
Set the minimum price from a string.
setType(HttpServletResponse) - Method in class mls.view.HtmlViewer
Sets the output type in the reponse for this type of viewer
setType(HttpServletResponse) - Method in class mls.view.Viewer
Sets the output type in the reponse for this type of viewer Implemented by child class
setType(HttpServletResponse) - Method in class mls.view.WmlViewer
Sets the output type in the reponse for this type of viewer
startIndex - Variable in class mls.domain.Results
The index at which this results set begins (0 if the parent set)
street - Variable in class mls.domain.Address
The street including number and apartment if applicable
style - Variable in class mls.domain.Property
 
style - Variable in class mls.domain.Query
Property style

T

TEMPLATE_DIR - Variable in class mls.view.Viewer
 
TEMPLATE_ROOT - Static variable in class mls.common.Config
 
TEST_RESULTS_FILE - Static variable in class mls.common.Config
 
TranslatingXmlObject - class mls.common.TranslatingXmlObject.
An XML aware object that can translate from XML to Java and back
TranslatingXmlObject() - Constructor for class mls.common.TranslatingXmlObject
 
type - Variable in class mls.domain.Property
 
type - Variable in class mls.domain.Query
Property type

U

UNAUTHORISED_USER - Static variable in class mls.common.Errors
 
uniqueID - Static variable in class mls.domain.Property
 
UNKNOWN - Static variable in class mls.domain.Property
An unknown type or style

V

VALID_STYLES - Static variable in class mls.domain.Property
 
VALID_TYPES - Static variable in class mls.domain.Property
 
validStyle(String) - Static method in class mls.domain.Property
Return true if this is a valid property style
validType(String) - Static method in class mls.domain.Property
Return true if this is a valid property type
view - Variable in class mls.domain.Lot
True if the land has a view
Viewer - class mls.view.Viewer.
An XML/XSLT based viewer that processes XML data and XSL page templates to generate markup This class could be optimized by caching stylesheet templates as DOM documents
Viewer() - Constructor for class mls.view.Viewer
 
viewError(HttpServletRequest, HttpServletResponse, String) - Method in class mls.view.Viewer
Display an error page containing the specified error message Calls the more general viewError method
viewError(HttpServletRequest, HttpServletResponse, String, Throwable) - Method in class mls.view.Viewer
Display an error page containing the specified error message and error (throwable) information
viewFixed(HttpServletResponse, String) - Method in class mls.view.HtmlViewer
View a canned page
viewFixed(HttpServletResponse, String) - Method in class mls.view.Viewer
View a canned page - Implemented by child class
viewFixed(HttpServletResponse, String) - Method in class mls.view.WmlViewer
View a canned page
viewPage(HttpServletRequest, HttpServletResponse, String, Object, String) - Method in class mls.view.Viewer
Display the specified page containing the specified object
viewPage(HttpServletRequest, HttpServletResponse, String, String, String) - Method in class mls.view.Viewer
Display the specified page containing a blank object of the specified class.

W

waterFront - Variable in class mls.domain.Lot
True if the land has water frontage
WML_PROLOGUE - Static variable in class mls.common.Config
 
WML_TEMPLATE_DIR - Static variable in class mls.common.Config
 
wmlViewer - Variable in class mls.controller.HttpServlet
Template processing WML viewer
WmlViewer - class mls.view.WmlViewer.
An XML/XSLT based viewer that processes XML data and XSL page templates to generate WML markup.
WmlViewer() - Constructor for class mls.view.WmlViewer
Default constructor
workflow - Variable in class mls.controller.HttpServlet
MLS workflow operations
Workflow - class mls.controller.Workflow.
Multiple listing service workflow operations that process user requests from Web and WAP browsers
Workflow() - Constructor for class mls.controller.Workflow
 

X

XML_PROLOGUE - Static variable in class mls.view.Viewer
 
xml2Object(String, String) - Static method in class mls.common.TranslatingXmlObject
Extract an object from the specified xml document file
XmlObject - class mls.common.XmlObject.
Methods to parse and access XML documents
XmlObject() - Constructor for class mls.common.XmlObject
 

A B C D E F G H I L M N O P Q R S T U V W X