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

A

Address - Class in org.apache.shale.usecases.rolodex
Holds an addres for a Contact.
Address() - Constructor for class org.apache.shale.usecases.rolodex.Address
 

B

BasicPerson - Class in org.apache.shale.usecases.symbols
This class describes the very minimum about a person.
BasicPerson() - Constructor for class org.apache.shale.usecases.symbols.BasicPerson
 
BusinessPerson - Class in org.apache.shale.usecases.symbols
This class represents a new category of a person documenting their employer or business entity name.
BusinessPerson() - Constructor for class org.apache.shale.usecases.symbols.BusinessPerson
 

C

changeTab() - Method in class org.apache.shale.usecases.rolodex.Rolodex
This action event is fired when clicking on a tab link.
compare(Object, Object) - Method in class org.apache.shale.usecases.rolodex.GenericComparator
Compares the property names in the sortBy list with the target sortable objects.
Contact - Class in org.apache.shale.usecases.rolodex
Represents an entity in the rolodex.
Contact() - Constructor for class org.apache.shale.usecases.rolodex.Contact
 
createCommandLinkMetadata(SelectItem, FacesContext) - Method in class org.apache.shale.usecases.rolodex.Rolodex
Creates an object graph uses to build the rolodex folder tabs dynamically.
createTabs(FacesContext, UIComponent, Object) - Method in class org.apache.shale.usecases.rolodex.Rolodex
This is a method binding event fired from the Clay component before building the component tree.
createVerbatimMetadata(String, String, FacesContext) - Method in class org.apache.shale.usecases.rolodex.Rolodex
This method builds a verbatim meta tag.
createVerbatimMetadata(String, FacesContext) - Method in class org.apache.shale.usecases.rolodex.Rolodex
This mehtod builds a simple verbatim meta tag.

D

decode(FacesContext, UIComponent) - Method in class org.apache.shale.usecases.rolodex.WebPagerRenderer
This basic component doesn't use javascript for navigation.
deleteContact() - Method in class org.apache.shale.usecases.rolodex.Rolodex
Removes a Contact from the mock data store.
deleteContact(Contact) - Method in class org.apache.shale.usecases.rolodex.RolodexDao
Removes the contact from the mock data store.

E

encodeBegin(FacesContext, UIComponent) - Method in class org.apache.shale.usecases.rolodex.HeaderSorterRenderer
Initiates the component rendering.
encodeBegin(FacesContext, UIComponent) - Method in class org.apache.shale.usecases.rolodex.WebPagerRenderer
Delegates to the super implementation.
encodeEnd(FacesContext, UIComponent) - Method in class org.apache.shale.usecases.rolodex.HeaderSorterRenderer
Completes component rendering.
encodeEnd(FacesContext, UIComponent) - Method in class org.apache.shale.usecases.rolodex.WebPagerRenderer
Locates a parent UIData component, decodes the selected page query parameter and advances the first row of the UIData component based on the selected page.

F

findContact(String) - Method in class org.apache.shale.usecases.rolodex.RolodexDao
Returns the latest copy of the Contact by primary key.
findContactsForTab(int) - Method in class org.apache.shale.usecases.rolodex.RolodexDao
Retuns a subset of contacts within the index of a a tab defined by TAB_INDEX from the mock data store.
findDataComponent(UIComponent) - Method in class org.apache.shale.usecases.rolodex.HeaderSorterRenderer
Finds the parent IUData component.
findDataComponent(UIComponent) - Method in class org.apache.shale.usecases.rolodex.WebPagerRenderer
Looks for the first data component parent.
findTabForContact(Contact) - Method in class org.apache.shale.usecases.rolodex.RolodexDao
This function will find the tabIndex that the Contact will be located on.
FullPerson - Class in org.apache.shale.usecases.symbols
This class extends the information collected by basic person.
FullPerson() - Constructor for class org.apache.shale.usecases.symbols.FullPerson
 

G

GenericComparator - Class in org.apache.shale.usecases.rolodex
Generic comparator that uses a list of property names to compare the state of two objects using the reflection API.
GenericComparator() - Constructor for class org.apache.shale.usecases.rolodex.GenericComparator
 
getAbbrCountry() - Method in class org.apache.shale.usecases.rolodex.State
 
getAbbrState() - Method in class org.apache.shale.usecases.rolodex.State
 
getActionStr(FacesContext) - Method in class org.apache.shale.usecases.rolodex.HeaderSorterRenderer
Returns the base context root of the form using the view handler.
getActionStr(FacesContext) - Method in class org.apache.shale.usecases.rolodex.WebPagerRenderer
Determines the base URL by calling on the view handler.
getAscImage() - Method in class org.apache.shale.usecases.rolodex.HeaderSorter
Returns the acending image resource location that is relative to the context root.
getBusinessAddress() - Method in class org.apache.shale.usecases.rolodex.Contact
Returns the business Address.
getBusinessName() - Method in class org.apache.shale.usecases.symbols.BusinessPerson
 
getBusinessPhone() - Method in class org.apache.shale.usecases.rolodex.Contact
Returns the business phone number.
getCaptionStyleClass() - Method in class org.apache.shale.usecases.rolodex.WebPager
Returns the pager captionStyleClass attribute.
getCity() - Method in class org.apache.shale.usecases.rolodex.Address
Returns the City.
getContactsForTab() - Method in class org.apache.shale.usecases.rolodex.Rolodex
This is called by the data table component to return a list of Contacts that belong within the selected index.
getCountries() - Method in class org.apache.shale.usecases.rolodex.RolodexDao
Returns an array of countries used to populate a select list.
getCountry() - Method in class org.apache.shale.usecases.rolodex.Address
Gets the Country.
getCountry() - Method in class org.apache.shale.usecases.rolodex.State
 
getCurrentPage(UIData) - Method in class org.apache.shale.usecases.rolodex.WebPagerRenderer
Returns the current page based on the UIData component's state.
getDescImage() - Method in class org.apache.shale.usecases.rolodex.HeaderSorter
Returns the decending image resource location that is relative to the context root.
getEmail() - Method in class org.apache.shale.usecases.rolodex.Contact
Returns the email address.
getEncodedName() - Method in class org.apache.shale.usecases.rolodex.Contact
Returns the name encoded.
getFamily() - Method in class org.apache.shale.usecases.rolodex.HeaderSorter
Sets the family to "org.apache.shale.Sorter".
getFamily() - Method in class org.apache.shale.usecases.rolodex.WebPager
Returns the component's family to "org.apache.shale.Pager".
getFirstName() - Method in class org.apache.shale.usecases.symbols.BasicPerson
 
getLastName() - Method in class org.apache.shale.usecases.symbols.BasicPerson
 
getMiddleName() - Method in class org.apache.shale.usecases.symbols.FullPerson
 
getName() - Method in class org.apache.shale.usecases.rolodex.Contact
Gets the entity name.
getNextImage() - Method in class org.apache.shale.usecases.rolodex.WebPager
Returns the pager nextImage attribute.
getNextPageStyleClass() - Method in class org.apache.shale.usecases.rolodex.WebPager
Returns the pager nextPageStyleClass attribute.
getPageEndIndex(FacesContext, UIData) - Method in class org.apache.shale.usecases.rolodex.WebPagerRenderer
Returns the ending row index displayed by the UIData component.
getPageEndIndex(int, FacesContext, UIData) - Method in class org.apache.shale.usecases.rolodex.WebPagerRenderer
Returns the ending row index displayed by the UIData component.
getPageIndex(FacesContext, UIData) - Method in class org.apache.shale.usecases.rolodex.WebPagerRenderer
Returns the selected page index.
getPageLinksStyleClass() - Method in class org.apache.shale.usecases.rolodex.WebPager
Returns the pager pageLinksStyleClass attribute.
getPages(UIData) - Method in class org.apache.shale.usecases.rolodex.WebPagerRenderer
Returns the total number of pages based on the size of the model's set and the total rows displayed.
getPageStartIndex(FacesContext, UIData) - Method in class org.apache.shale.usecases.rolodex.WebPagerRenderer
Returns the starting row within the UIData's model based on the selected page index, the total rows the model has and the rows per page.
getPageStartIndex(int, FacesContext, UIData) - Method in class org.apache.shale.usecases.rolodex.WebPagerRenderer
Returns the starting row within the UIData's model based on the selected page index, the total rows the model has and the rows per page.
getPageTag(FacesContext, UIData) - Method in class org.apache.shale.usecases.rolodex.WebPagerRenderer
Returns the query parameter tag based on the parent UIData component.
getPrefix() - Method in class org.apache.shale.usecases.symbols.FullPerson
 
getPrevImage() - Method in class org.apache.shale.usecases.rolodex.WebPager
Returns the pager prevImage attribute.
getPrevPageStyleClass() - Method in class org.apache.shale.usecases.rolodex.WebPager
Returns the pager prevPageStyleClass attribute.
getProvince() - Method in class org.apache.shale.usecases.rolodex.Address
Gets the Province.
getRendersChildren() - Method in class org.apache.shale.usecases.rolodex.WebPager
The pager component renders children.
getResidentialAddress() - Method in class org.apache.shale.usecases.rolodex.Contact
Gets the residential Address.
getResidentialPhone() - Method in class org.apache.shale.usecases.rolodex.Contact
Gets the residential phone number.
getRowsOnPage(int, FacesContext, UIData) - Method in class org.apache.shale.usecases.rolodex.WebPagerRenderer
Returns the total rows on the selected page.
getRowsPerPage(UIData) - Method in class org.apache.shale.usecases.rolodex.WebPagerRenderer
Returns the rows per page of the UIData component.
getSelectedContact() - Method in class org.apache.shale.usecases.rolodex.Rolodex
Returns the selected contact for edit.
getSelectedName() - Method in class org.apache.shale.usecases.rolodex.QueryParam
 
getSelectedTab() - Method in class org.apache.shale.usecases.rolodex.Rolodex
Returns the current tab index.
getSortAscending() - Method in class org.apache.shale.usecases.rolodex.GenericComparator
Returns true if the collection should be sorted ascending by the sortBy properties list.
getSortBy() - Method in class org.apache.shale.usecases.rolodex.GenericComparator
Returns a comma delimited list of property names used to compare two objects.
getSortBy() - Method in class org.apache.shale.usecases.rolodex.HeaderSorter
Returns a comma delimited list of properties to sort by.
getSortedTag(FacesContext, UIData) - Method in class org.apache.shale.usecases.rolodex.HeaderSorterRenderer
The name of the query parameter used to control column sorting.
getSortName() - Method in class org.apache.shale.usecases.rolodex.Contact
Returns the name in upper case.
getState() - Method in class org.apache.shale.usecases.rolodex.Address
Gets the State.
getState() - Method in class org.apache.shale.usecases.rolodex.State
 
getStates() - Method in class org.apache.shale.usecases.rolodex.RolodexDao
Returns an array of states used to populate a select list.
getStreet1() - Method in class org.apache.shale.usecases.rolodex.Address
Gets the Street1.
getStreet2() - Method in class org.apache.shale.usecases.rolodex.Address
Gets the Street2.
getSuffix() - Method in class org.apache.shale.usecases.symbols.FullPerson
 
getTabIndex() - Method in class org.apache.shale.usecases.rolodex.Contact
Returns the first char of the name use by the rolodex index.
getTabIndex() - Method in class org.apache.shale.usecases.rolodex.QueryParam
 
getTabs() - Method in class org.apache.shale.usecases.rolodex.RolodexDao
Returns a list of SelectItem that will be used to build the links.
getZip() - Method in class org.apache.shale.usecases.rolodex.Address
Gets the Zip Code.
getZipAsString() - Method in class org.apache.shale.usecases.rolodex.Address
Gets the Zip Code.

H

HeaderSorter - Class in org.apache.shale.usecases.rolodex
 
HeaderSorter() - Constructor for class org.apache.shale.usecases.rolodex.HeaderSorter
Sets the renderer type to "org.apache.shale.HeaderSorter".
HeaderSorterRenderer - Class in org.apache.shale.usecases.rolodex
 
HeaderSorterRenderer() - Constructor for class org.apache.shale.usecases.rolodex.HeaderSorterRenderer
 

I

init() - Method in class org.apache.shale.usecases.symbols.RegistrationForm
This view controller is scoped in the request.
isSortAscending() - Method in class org.apache.shale.usecases.rolodex.HeaderSorter
Returns true if the model data is sorted in ascending order defined by the sortBy property.
iterator(FacesContext, UIData) - Method in class org.apache.shale.usecases.rolodex.WebPagerRenderer
Returns a PageInfo Iterator used to render the individual page links.

L

loadStates() - Method in class org.apache.shale.usecases.rolodex.RolodexDao
Loads the State codes and contacts from an XML data source.
log - Static variable in class org.apache.shale.usecases.rolodex.GenericComparator
Common logger utility.

N

newContact() - Method in class org.apache.shale.usecases.rolodex.Rolodex
Creates a new Contact instance to be entered and saved.
nextPage(FacesContext, UIData) - Method in class org.apache.shale.usecases.rolodex.WebPagerRenderer
Returns PageInfo that defines the next link.

O

org.apache.shale.usecases.rolodex - package org.apache.shale.usecases.rolodex
 
org.apache.shale.usecases.symbols - package org.apache.shale.usecases.symbols
 

P

prevPage(FacesContext, UIData) - Method in class org.apache.shale.usecases.rolodex.WebPagerRenderer
Returns PageInfo used to render the previous page links.

Q

QueryParam - Class in org.apache.shale.usecases.rolodex
This class simulates the classic struts FormBean.
QueryParam() - Constructor for class org.apache.shale.usecases.rolodex.QueryParam
 

R

RegistrationForm - Class in org.apache.shale.usecases.symbols
This view controller manages state outside of the managed beans associated with the form.
RegistrationForm() - Constructor for class org.apache.shale.usecases.symbols.RegistrationForm
 
restoreState(FacesContext, Object) - Method in class org.apache.shale.usecases.rolodex.HeaderSorter
Restores the component's state.
restoreState(FacesContext, Object) - Method in class org.apache.shale.usecases.rolodex.WebPager
Restores the components state.
Rolodex - Class in org.apache.shale.usecases.rolodex
The ViewController for the rolodex use case.
Rolodex() - Constructor for class org.apache.shale.usecases.rolodex.Rolodex
 
RolodexDao - Class in org.apache.shale.usecases.rolodex
Data Access Object for the roledex use case.
RolodexDao() - Constructor for class org.apache.shale.usecases.rolodex.RolodexDao
The constructor loads some default data.

S

save() - Method in class org.apache.shale.usecases.symbols.RegistrationForm
Handles action of saving the pages state.
saveContact() - Method in class org.apache.shale.usecases.rolodex.Rolodex
Saves a Contact to the mock data store.
saveContact(Contact) - Method in class org.apache.shale.usecases.rolodex.RolodexDao
Saves a Contact to the mock data store.
saveState(FacesContext) - Method in class org.apache.shale.usecases.rolodex.HeaderSorter
Saves the component's state.
saveState(FacesContext) - Method in class org.apache.shale.usecases.rolodex.WebPager
Saves the components state.
selectContact() - Method in class org.apache.shale.usecases.rolodex.Rolodex
This is an action event fired from clicking on a contact in the data grid.
setAbbrCountry(String) - Method in class org.apache.shale.usecases.rolodex.State
 
setAbbrState(String) - Method in class org.apache.shale.usecases.rolodex.State
 
setAscImage(String) - Method in class org.apache.shale.usecases.rolodex.HeaderSorter
Sets the acending image resource location that is relative to the context root.
setBusinessAddress(Address) - Method in class org.apache.shale.usecases.rolodex.Contact
Sets the business Address.
setBusinessName(String) - Method in class org.apache.shale.usecases.symbols.BusinessPerson
 
setBusinessPhone(String) - Method in class org.apache.shale.usecases.rolodex.Contact
Sets the business phone number.
setCaptionStyleClass(String) - Method in class org.apache.shale.usecases.rolodex.WebPager
Sets the pager captionStyleClass attribute.
setCity(String) - Method in class org.apache.shale.usecases.rolodex.Address
Sets the City.
setCountry(String) - Method in class org.apache.shale.usecases.rolodex.Address
Sets the Country.
setCountry(String) - Method in class org.apache.shale.usecases.rolodex.State
 
setDescImage(String) - Method in class org.apache.shale.usecases.rolodex.HeaderSorter
Sets the decending image resource location that is relative to the context root.
setEmail(String) - Method in class org.apache.shale.usecases.rolodex.Contact
Sets the email address.
setFirstName(String) - Method in class org.apache.shale.usecases.symbols.BasicPerson
 
setLastName(String) - Method in class org.apache.shale.usecases.symbols.BasicPerson
 
setMiddleName(String) - Method in class org.apache.shale.usecases.symbols.FullPerson
 
setName(String) - Method in class org.apache.shale.usecases.rolodex.Contact
Sets the entity name.
setNextImage(String) - Method in class org.apache.shale.usecases.rolodex.WebPager
Sets the pager nextImage attribute.
setNextPageStyleClass(String) - Method in class org.apache.shale.usecases.rolodex.WebPager
Sets the pager nextPageStyleClass attribute.
setPageLinksStyleClass(String) - Method in class org.apache.shale.usecases.rolodex.WebPager
Sets the pager pageLinksStyleClass attribute.
setPrefix(String) - Method in class org.apache.shale.usecases.symbols.FullPerson
 
setPrevImage(String) - Method in class org.apache.shale.usecases.rolodex.WebPager
Sets the pager prevImage attribute.
setPrevPageStyleClass(String) - Method in class org.apache.shale.usecases.rolodex.WebPager
Sets the pager prevPageStyleClass attribute.
setProvince(String) - Method in class org.apache.shale.usecases.rolodex.Address
Sets the Province.
setResidentialAddress(Address) - Method in class org.apache.shale.usecases.rolodex.Contact
Sets the residential Address.
setResidentialPhone(String) - Method in class org.apache.shale.usecases.rolodex.Contact
Sets the residential phone number.
setSelectedContact(Contact) - Method in class org.apache.shale.usecases.rolodex.Rolodex
Sets the selected contact for edit.
setSelectedName(String) - Method in class org.apache.shale.usecases.rolodex.QueryParam
 
setSelectedTab(int) - Method in class org.apache.shale.usecases.rolodex.Rolodex
Records a change in tab index.
setSortAscending(boolean) - Method in class org.apache.shale.usecases.rolodex.GenericComparator
Sets the sequence the collection should be sorted.
setSortAscending(boolean) - Method in class org.apache.shale.usecases.rolodex.HeaderSorter
This setter toggles the collating sequence from ascending to descending.
setSortBy(String) - Method in class org.apache.shale.usecases.rolodex.GenericComparator
Passed a comma delimited list of property names to compare two object by.
setSortBy(String) - Method in class org.apache.shale.usecases.rolodex.HeaderSorter
Sets a comma delimited list of properties to sort by.
setState(String) - Method in class org.apache.shale.usecases.rolodex.Address
Sets the State.
setState(String) - Method in class org.apache.shale.usecases.rolodex.State
 
setStreet1(String) - Method in class org.apache.shale.usecases.rolodex.Address
Sets the Street1.
setStreet2(String) - Method in class org.apache.shale.usecases.rolodex.Address
Sets the Street2.
setSuffix(String) - Method in class org.apache.shale.usecases.symbols.FullPerson
 
setTabIndex(String) - Method in class org.apache.shale.usecases.rolodex.QueryParam
 
setZip(int) - Method in class org.apache.shale.usecases.rolodex.Address
Sets the Zip Code.
setZipAsString(String) - Method in class org.apache.shale.usecases.rolodex.Address
Sets the Zip Code.
sortBy - Variable in class org.apache.shale.usecases.rolodex.GenericComparator
Holds an array of property names in the target object that will be use to compare the two objects.
State - Class in org.apache.shale.usecases.rolodex
Represents a State domain object.
State() - Constructor for class org.apache.shale.usecases.rolodex.State
 

T

TAB_INDEX - Static variable in class org.apache.shale.usecases.rolodex.RolodexDao
Tab indexes for the rolodex.

W

wasSelected() - Method in class org.apache.shale.usecases.rolodex.HeaderSorter
Returns true if the component was selected.
wasSelected(FacesContext, UIData, HeaderSorter) - Method in class org.apache.shale.usecases.rolodex.HeaderSorterRenderer
Determines if the column was click to be sorted on.
WebPager - Class in org.apache.shale.usecases.rolodex
 
WebPager() - Constructor for class org.apache.shale.usecases.rolodex.WebPager
Sets the renderer type to "org.apache.shale.WebPager".
WebPagerRenderer - Class in org.apache.shale.usecases.rolodex
 
WebPagerRenderer() - Constructor for class org.apache.shale.usecases.rolodex.WebPagerRenderer
 
writeNextPageLink(FacesContext, UIData, UIComponent) - Method in class org.apache.shale.usecases.rolodex.WebPagerRenderer
Generates the next page link.
writePageCaption(FacesContext, UIData, UIComponent) - Method in class org.apache.shale.usecases.rolodex.WebPagerRenderer
Writes a pager caption documenting the total model rows, current page and total pages.
writePageIndex(FacesContext, UIData, UIComponent) - Method in class org.apache.shale.usecases.rolodex.WebPagerRenderer
Renders a hidden input field that keeps track of the current page.
writePageLinks(FacesContext, UIData, UIComponent) - Method in class org.apache.shale.usecases.rolodex.WebPagerRenderer
The first ten pages are displayed as individual page links.
writePrevPageLink(FacesContext, UIData, UIComponent) - Method in class org.apache.shale.usecases.rolodex.WebPagerRenderer
Writes the previous page link.

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

Copyright © 2004-2007 Apache Software Foundation. All Rights Reserved.