Class JourneySat.Travel

Object
   |
   +--JourneySat.Travel

class JourneySat.Travel

This class manages the information about a travel and the status of the navigation in the journal. A travel is sequence of days (JourneySat.Day); each day contains a sequence of places (JourneySat.Place) and each place holds a sequence of contents (JourneySat.Content). The status of the travel is represented by a current day, a current place and a current content. It can be accessed using the getCurrentDay, getCurrentDayIndex, getCurrentPlace, getCurrentPlaceIndex, getCurrentContent and getCurrentContentIndex methods. The contents in a place can also be accessed with getContentArray.
Defined in travel.js

Field Detail

loader

Object loader

JourneySat.Travel

JourneySat.Travel()

asynchronousMode

void asynchronousMode(<boolean> mode)

Sets the synchronization mode for the XMLHttpRequest that loads the XML from the remote server. The default mode is asynchronous communication.

Parameters:
mode - true for asynchronous communication, false for synchronous.

changeDay

boolean changeDay(<JourneySat.Date> newDate)

Changes the date of the current day. If !newDate.isValid the day the sequence number doesn't change, otherwise the day is moved to keep the day sequence sorted by date. If there is already a day with a date equal to the day's new date no changes are made.

Parameters:
newDate - The new date for the day
dayNode - A reference to the tree node that contains the day

Returns:
True for success, false if there is already a day with date equal to newDate or the travel doesn't contain any day

deleteContent

void deleteContent()

Removes the current content from the travel. The content after the removed one becomes the current one. If the place that was removed was the last one in the day, the place before it becomes the current place.

deleteDay

void deleteDay()

Removes the current day from the travel sequence. The day after the removed one becomes the current day. If the day that was removed was the last in the travel, the day before it becomes the current day. The current place is the first place in the current day. The current content is set to the first content of the current place or to null is place is null.

deletePlace

void deletePlace()

Removes the current place from the travel. The place after the removed one becomes the current place. If the place that was removed was the last one in the day, the place before it becomes the current place.

firstDay

void firstDay()

Moves to the first day of the travel and updates. If the day has no places the current place will be set to null and its index to -1, otherwise they refer to the first place of the day. The current content is set to the first content of the place, or to null if place is null.

firstPlace

void firstPlace()

Moves to the first place of the travel. If there are no places in this travel the current place is set to null. The current content is set to the first content of the place, or to null if place is null.

getContentArray

JourneySat.Content[] getContentArray()

Returns the contents of the current place as an array.

Returns:
The contents of the current place

See:
- getCurrentContent()

getCurrentContent

JourneySat.Content getCurrentContent()

Returns the current content.

Returns:
The current content

getCurrentContentIndex

int getCurrentContentIndex()

Returns the position of the current content in the sequence of the contents inside the current place.

Returns:
The current content position, base 0

See:
- getContentArray()

getCurrentDay

JourneySat.Day getCurrentDay()

Returns the current day.

Returns:
The current day

getCurrentDayIndex

int getCurrentDayIndex()

Returns the position of the current day in the sequence of travel days. This is not necessarily the day sequence number because there might be gaps in those numbers.

Returns:
The current day position, base 0

getCurrentPlace

JourneySat.Place getCurrentPlace()

Returns the current place.

Returns:
The current place

getCurrentPlaceIndex

int getCurrentPlaceIndex()

Returns the position of the current place in the sequence of travel days.

Returns:
The current place position, base 0

getCurrentPoint

GPoint getCurrentPoint()

Returns the GPoint object corresponding to the coordinates of the current place

Returns:
The current point

getEndDate

JourneySat.Date getEndDate()

Returns the end date of the travel as a JourneySat.Date object

Returns:
The end date

getNumberOfContents

int getNumberOfContents()

Returns the number of contents in the travel

Returns:
The number of contents

getNumberOfDays

int getNumberOfDays()

Returns the number of days in the travel

Returns:
The number of days

getNumberOfPlaces

int getNumberOfPlaces()

Returns the number of places in the travel

Returns:
The number of places

getRequest

XMLHttpRequest getRequest()

Returns the request object used to retrieve the XML from the server

Parameters:
the - request

getStartDate

JourneySat.Date getStartDate()

Returns the start date of the travel as a JourneySat.Date object

Returns:
The start date

getTravelDates

String getTravelDates()

Returns the date range of the travel as a string in the format yyyy/mm/dd - yyyy/mm/dd

Returns:
The date range of the travel

getTravelDescription

String getTravelDescription()

Returns the description of the travel

Returns:
The description of the travel

getTravelTitle

String getTravelTitle()

Returns the travel title

Returns:
The travel title

getZoomLevel

int getZoomLevel()

Returns the default zoom level for the travel.

Returns:
The zoom level

goToDay

void goToDay(<int> n)

Moves to the n-th day in the travel. Does nothing if n is <= 0 or greater than the number of days in the travel. If the day has no places the current place will be set to null and its index to -1, otherwise they refer to the last place of the day. The current content is set to the first content of the place, or to null if place is null.

Parameters:
n - The number of the day, the first day of the travel is numbered as 1.

goToPlace

void goToPlace(<int> n)

Moves to the n-th place in the travel. Does nothing if n is <= 0 or greater than the number of places in the travel.

Parameters:
n - The number of the place, the first place of the travel is numbered as 1.

insertContent

Object insertContent()

insertDay

boolean insertDay(newDay)

Adds a new day to the travel. If a day has a date it is inserted at the appropriate place in the days list, to keep the days sorted by date. If the day doesn't have a date it is inserted before the current day. If the day has a date and there is already a day with the same date in the travel, the day isn't added. After the inserted current day is set to the new day, the days are resequenced and the index to the current day is set. The current place is set to null and the index of the current place is set to -1. The current content is set to null.

Parameters:
day - The day

Returns:
True if the day has been added to the travel, false if not

insertPlace

boolean insertPlace()

Adds a new place to the travel. The place belongs to the current day and is inserted after the current place. The new place becomes the current one.If there are no days in the travel it returns without doing anything.

Returns:
True if the place has been added to the travel, false if not.

isAsynchronous

boolean isAsynchronous()

Returnes the synchronization mode

Returns:
True for asynchronous communication, false for synchronous.

lastDay

void lastDay()

Moves to the last day of the travel. If the day has no places the current place will be set to null and its index to -1, otherwise they refer to the last place of the day. The current content is set to the first content of the place, or to null if place is null.

lastPlace

void lastPlace()

Moves to the last place and to the last day of the travel. The current content is set to the first content of the place.

load

void load()

Loads the XML file and creates the internal data structure that represents the travel. The current day is set to the first day of the travel and the current place is set to the first place of that day.

log

void log(<String> msg)

Logs a message. The current implementation is an alert dialog. Recommended only for debugging purposes.

Parameters:
msg - the message to log

moveDownContent

void moveDownContent()

Swaps the current content with the one that follows it in a place. The index of the current content is increased by one. Applying this method to the last content in a place doesn't do anything.

moveDownDay

boolean moveDownDay()

Swaps the current day with the one that follows it in the travel sequence. Dates must keep an ascending order so at least one of the two days must have an empty date. Applying this method to the last day of the travel doesn't change the travel sequence. The Current day and place don't change. The index of the current day is increased by one, the index of the current place changes as necessary

Returns:
true if the swap succeeded, false if not

moveDownPlace

void moveDownPlace()

Swaps the current place with the one that follows it in a day. The index of the current place is increased by one. Applying this method to the last place in a day doesn't do anything.

moveUpContent

void moveUpContent()

Swaps the current content with the one that precedes it in a place. The index of the current content is decreased by one. Applying this method to the first content in a place doesn't do anything.

moveUpDay

boolean moveUpDay()

Swaps the current day with the one that precedes it in the travel sequence. Dates must keep an ascending order so at least one of the two days must have an empty date. Applying this method to the first day of the travel doesn't change the travel sequence. The current day and place don't change. The index of the current day is decreased by one, the index of the current place changes as necessary

Returns:
true if the swap succeeded, false if not. It returns true also when the current day is the first day of the travel or the travel doesn't contain any day.

moveUpPlace

void moveUpPlace()

Swaps the current place with the one that precedes it in a day. The index of the current place is decreased by one. Applying this method to the first place in a day doesn't do anything.

nextContent

void nextContent()

Moves the current content to the one that follows it in the same place.

nextDay

void nextDay()

Moves to the next day of the travel. If the day has no places the current place will be set to null and its index to -1, otherwise they refer to the first place of the day. The current content is set to the first content of the place, or to null if place is null. If the day is the last day of the travel, nothing is done.

nextPlace

void nextPlace()

Moves the current place to the next place in the travel and update the current day if needed

onload

void onload()

Handler function, called when Loader completes loading the XML file. Usually defined by the client of Travel.

prevContent

void prevContent()

Moves the current content to the one that precedes it in the same place.

prevDay

void prevDay()

Moves to the previous day of the travel. If the day has no places the current place will be set to null and its index to -1, otherwise they refer to the last place of the day. The current content is set to the first content of the place, or to null if place is null. If the day is the first day of the travel, nothing is done.

prevPlace

void prevPlace()

Moves the current place to the previous place in the travel and also update the current day if needed.

setDataFile

void setDataFile(<String> dataFile)

Specifies the URL of the XML data file. Browsers usually force it the be a URL on the web server hosting the web page that contains the map.

Parameters:
dataFile - the URL of the XML data file

setEndDate

void setEndDate(<JourneySat.Date> date)

Sets the end date of the travel

Parameters:
date - The end date, of type JourneySat.Date

setNumberOfContents

void setNumberOfContents(<int> contents)

Sets the number of contents

Parameters:
contents - The number of contents

setNumberOfDays

void setNumberOfDays(<int> days)

Sets the number of days

Parameters:
days - The number of days

setNumberOfPlaces

void setNumberOfPlaces(<int> places)

Sets the number of places

Parameters:
places - The number of places

setStartDate

void setStartDate(<JourneySat.Date> date)

Sets the start date of the travel

Parameters:
date - The start date, of type JourneySat.Date

setTravelDescription

void setTravelDescription(<String> descr)

Sets the description of the travel

Parameters:
descr - The description of the travel

setTravelTitle

void setTravelTitle(<String> title)

Sets the travel title

Parameters:
title - The travel title

setZoomLevel

void setZoomLevel(<int> zoomLevel)

Sets the default zoom level for the travel.

Parameters:
zoomLevel - The zoom level

toString

String toString()

Returns a XML representation of the places array.

Returns:
The XML string containing the travel data.

getFormattedDate

<static> String getFormattedDate(<int> sY, <int> sM, <int> sD, <String> sep)

Prepares a formatted representation of a date in the format yyyymmdd. The values are left-padded with 0 characters and the separation character can be any string (even empty or longer than one character) If year and month and day are null or empty strings an empty string is returned regardless of the value of the separator.

Parameters:
sY - the year
sM - the month
sD - the day
sep - the separator

Returns:
A date in the format yyyymmdd.