iskradelta / x9-places Goto Github PK

The page for viewing venues:
https://docs.google.com/Doc?docid=0AbInpf_Uf9e6ZGdubTVrOHZfOTQ5MnR3Z25kaw&hl=en_
GB#5_3_4_VenuePage_61328195607710

Setup the server at Kristoffer so it works.

In charge: Kristoffer and Anto.

Address: http://85.227.184.106:8888/foodle-x9/

"This function is called with a list of address's as parameter and will
return a navigation map displaying marks on the specified address's. These
marks will represent venues and lets the user access venue information
through mouse interaction, for example left clicking the marker."

A servlet for adding new reviews:
https://docs.google.com/Doc?docid=0AbInpf_Uf9e6ZGdubTVrOHZfOTQ5MnR3Z25kaw&hl=en_
GB#5_4_2_add_29346455873993293_32

A servlet for marking a venue as closed:
https://docs.google.com/Doc?docid=0AbInpf_Uf9e6ZGdubTVrOHZfOTQ5MnR3Z25kaw&hl=en_
GB#5_3_4_markClosed_0027906811311_05099030911385205

Perhaps this should be a part of add/update controller:
https://code.google.com/p/x9-places/issues/detail?id=28&sort=summary

Copy from ADD:

- Purpose -
The purpose is to present the user with an ability to modify their personal
settings.

- Links to -
The search function exists in the top left corner and the logo takes back
to the starting page.

- Function -
The account settings page displays information about the user like profile
text, picture, email, address and so on. The user can then edit these
fields as they see fit.

How does simultaneous updates to Solr work? To update a document in Solr,
you first query it, edit it in memory, and then send it back with the same
id. If two users were to query the document at the same time, and then
submit a modified version, the last user to submit would get his edit
through. How do we handle this? Especially regarding tags, if they are
stored in the same document. Many users could potentially add tags to the
same object at the same time.

(There's also the issue of generating unique ids for the documents, but
that is easier to solve.)

It's mostly done.

I suggest we create a file/the files for the schemas that Solr will need
and store them in the scripts folder (or somewhere more appropriate).

Who wants to do this? I suggest Anto.

Copy from ADD:

"To display a page where the user can log in to Foodle, using either a
local account or Facebook Connect. The page is split in the middle, where
the left side handles login, and the right side has a form to create a new
account."

A controller for rating a venue:
https://docs.google.com/Doc?docid=0AbInpf_Uf9e6ZGdubTVrOHZfOTQ5MnR3Z25kaw&hl=en_
GB#5_3_2_4_Rate_28742952201563576

"This view shall take an address parameter and return javascript-code for a
corresponding map. The view will display a map with a mark of the specified
address."

Copy from ADD:

- Purpose -
The purpose is to present the viewer with a profile page. This could be any
users profile page.

- Links to -
This is currently a deluxe version item (URD 3.1.6.9). We will add
functionality if time permits.

- Function -
The profile page exists to give the users a personal touch. The profile
page displays a user picture and reputation level among other things. In
the deluxe version it would also link to the users friends, favourite
venues and own reviews etc.

- Data -
All data to be displayed will be taken from the User model.

Copy from ADD:
https://docs.google.com/Doc?docid=0AbInpf_Uf9e6ZGdubTVrOHZfOTQ5MnR3Z25kaw&hl=en_
GB#5_2_2_1_Search_018306467502695


Purpose
    The purpose of the class is to fulfill the requirements set in SRD 3.1.2
Search Handling - search.

Function
    SearchController will inspect the search string and determine what to do
depending on the search string (for example the number of keywords to
search for) and other parameters such as the selection of advanced search
(for example search for a specific location).
After successful completion, the user will be redirected to an appropriate
page, which will display either a list of results corresponding to the
search string or  a map (using GoogleMap) centered on the location and
displaying venue locations corresponding to the search string.

Subordinates
    None since there is no Search Model.

Dependencies
    None.

Interfaces
    Input:
Search takes as GET parameters the search string.

Output:
The user is redirected to an appropriate page which will display either a
list of results corresponding to the search string or  a map (using
GoogleMap) centered on the location and displaying venue locations
corresponding to the search string.

Resources
    None.

References
    None.

Processing
    Inspects the search string and determines by which method to search,
depending on the complexity of the string and on the different options the
user selected (such as advanced search, for example).

The SearchController uses the search keywords to call Search on each of
them with the method inspectString. It then processes a query to Solr with
method querySolr which responds with an XML-document containing Venue-data,
Review-data, and Tags found sorted according to Solr's relevancy algorithm.
The Search inspectString method then uses the XML-results to update the
respective model classes according to field and attribute. When this is
finished the Search returns success or failure and SearchController can
select which view to show (a list of results or a Map), if success show
searchResults.jsp which includes the model classes attributes to be shown.
If failure show nonefound.jsp.

In case of a location search (chosen by the user with advanced search
functionalities) the SearchController receives a list of venue-addresses in
proximity to the location given and calls the browseByMap method which
returns a map displaying these venue locations.

Some rules for how to inspect the search string and determine by which
method to search can be specified here: If the search string contains "in"
it will assume the right word is a location. If the words are surrounded by
and, it will search for venues and tags containing at least both words. If
the words are delimited by or, the search is for either of the words, which
means coffee or bar will return documents containing either of the words.

Data
    None.

Be inspired by VenueModel. 

The current Solr-schema accepts both venues and reviews, it is only
differentiated by the field "type" set it to review. 

Add jsptags to add, show and rate reviews. 

Later we add a field to shema.xml like "venueHasReviewID" and
"writtenByUserID" and change VenueModel and ReviewModel adequatly.

This doesn't work. 

Some links:

http://wiki.apache.org/tomcat/FAQ/CharacterEncoding#Q1

http://java.sun.com/j2se/1.5.0/docs/api/index.html?java/net/URLEncoder.html

http://split-s.blogspot.com/2005/12/internationalized-get-parameters-with.html

http://stackoverflow.com/questions/1365806/why-the-character-is-corrupted-when-u
se-request-getparameter-in-java

Someone care to do this. Perhaps I should do it, as I've been trying to fix
it for a couple of hours, but it is SOOOOOOOOO boring.

A controller for registering a new user

Trying to register a new user with the same username or email as an
existing one currently throws an exception. It shouldn't.

I don't really know how to solve this. But I guess there are two ways: 

1. Catch the exception and parse it for clues as to why something went
wrong. If it was due to a "Integrity Contstraint Violation", the username
or email wasn't unique.

More: http://java.sun.com/javase/7/docs/api/

2. Somehow do it as a transaction, first selecting any users with the same
username or email, and if the selection is empty, insert. But what if the
entire transaction fails, either due to someone else doing stuff, or
because of bad sql?

More: http://java.sun.com/docs/books/tutorial/jdbc/basics/transactions.html

A controller for adding new venues:
https://docs.google.com/Doc?docid=0AbInpf_Uf9e6ZGdubTVrOHZfOTQ5MnR3Z25kaw&hl=en_
GB#5_3_2_add_743615463647184_3507_8343348872210783

We should each of us set up the dev enviroment, and leave a comment here
when we have.

Copy from ADD: 

https://docs.google.com/Doc?docid=0AbInpf_Uf9e6ZGdubTVrOHZfOTQ5MnR3Z25kaw&hl=en_
GB#5_3_5_FriendsFeedsPage_8001547

- Purpose -
The purpose is the present the user with their friends recent activity,
such as latest reviews.

- Links to -
* ProfilePageView (other users)
* UserReviews //Correct this, check further down in document for the
correct name. --William

- Function -
The friend feeds page displays information of the latest activity performed
by a users 'friends'. The specifics about this will be revealed in the
deluxe version.

I suggest we create a file that has the necessary SQL to create all
databases/tables/users/permissions etc. that we'll need for foodle. That
way, we can easily all have the same tables with minimum work, and we can
have the table definitions version controlled.

Who wants to do this?

Structuring of the main page into header, content and footer parts.

Copy from ADD:
https://docs.google.com/Doc?docid=0AbInpf_Uf9e6ZGdubTVrOHZfOTQ5MnR3Z25kaw&hl=en_
GB#5_2_3_1_Result_Page_5658459707

Identifier
    ResultPageView
Purpose
    The purpose is to present the viewer with a page displaying the results
matching a search string.

Links to

    * Login page.
    * Venue Page.
    * Result Page. (the current page refreshed while selecting a category
on the left)

Function
    To display a page where the user can see the results (Venues) for his
search. The page is divided into three vertical columns, the middle one
(the main one) displays a search field, some filters and the list of
results and the left one displays some categories the user should be able
to select.

Subordinates
    None.

Dependencies
    The Search Controller (5.2.2)

References
    See Figure 4.2.3.2 Sitemap.

Data
    All data displayed will be taken from the venue models.

It's mostly done

The "widget" you click on to rate a venue. Could be as simple as a <select>
drop-box with 10 ratings as menu items, or more complex a la imdb.com

The model for reviews:
https://docs.google.com/Doc?docid=0AbInpf_Uf9e6ZGdubTVrOHZfOTQ5MnR3Z25kaw&hl=en_
GB#5_4_1_Model_8379168627160254_0

Should be very similar to the VenueModel class.

[deleted issue]

Copy from ADD:

"The purpose is to present the viewer with a small login screen for quick
access. The box will commonly be presented in the top right corner of the
page."

and

"It attempts to login the user after the user has entered account name, 
password and then clicked the login button."

The view that displays a review, to be used when displaying a venue page:
https://docs.google.com/Doc?docid=0AbInpf_Uf9e6ZGdubTVrOHZfOTQ5MnR3Z25kaw&hl=en_
GB#5_4_3_1_ReviewPageView_7175840_7746580757114662

For testing purposes, show the 10 latest venues in the index page.
There is code in venue/view.jsp to get a venue by id, move this to a jsp
tag in WEB-INF/tags then use the tag in index.jsp to show one venue, then
get some more and display.
This code will be used then in view.jsp and review. 

A servlet for ranking reviews:
https://docs.google.com/Doc?docid=0AbInpf_Uf9e6ZGdubTVrOHZfOTQ5MnR3Z25kaw&hl=en_
GB#5_4_3_rank_4091803254524966_79

Someone should split the remaining ADD stuff into separate tickets here.

Start working on the UserController.

ADD: https://docs.google.com/Doc?docid=0AbInpf_Uf9e6ZGdubTVrOHZfOTQ5MnR3Z25
kaw&hl=en_GB

SRD: https://docs.google.com/Doc?docid=0AbInpf_Uf9e6ZGdubTVrOHZfOTNoam1idGN
obg&hl=en_GB

Already mostly done, I just need to make it more secure. And to add
"remember me" functionality.

How will we implement tags? It seems to be quite difficult, and there are
few discussions about it online.

Here's how we probably should do it:
http://wiki.apache.org/solr/UserTagDesign

Does anyone understand that? (If you do, implement it :))

Perhaps some more info:
http://www.mail-archive.com/[email protected]/msg05807.html

Copy from the ADD: 

"It initiates the process of authorizing the connection of the user's
Facebook account with Foodle. All the work is done by Facebook, this is
essentially just the button-click. On a successful connection to Facebook,
the user is logged in. Otherwise nothing changes."