Class Index | File Index

Classes


Class DataReader

Used to parse single POI objects.
Defined in: jquery.citysdk-tourism.datareader.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
Method Summary
Method Attributes Method Name and Description
<static>  
DataReader.getAvailableLanguages(poi, field)
Gets the available languages for the POI object.
<static>  
DataReader.getCalendar(poi, term)
Gets the calendar with a given term from the POI object.
<static>  
DataReader.getCategories(poi, lang)
Gets the categories in a given language.
<static>  
DataReader.getContacts(poi)
Gets the contacts from the POI object.
<static>  
DataReader.getDescription(poi, lang)
Gets a given description from the POI object with a given language.
<static>  
DataReader.getImagesUri(poi)
Gets all image URI from the link section of the POI object.
<static>  
DataReader.getLabel(poi, term, lang)
Gets a label description from the POI object with a given term in a given language.
<static>  
DataReader.getLink(poi, term)
Gets a given link with a given term from the POI object.
<static>  
DataReader.getLocalLanguage()
Gets the local language and country.
<static>  
DataReader.getLocationGeometry(poi, term)
Gets all geometries from the location of the POI object with a given term.
<static>  
DataReader.getLocationLine(poi, term)
Gets the lines from the location of the POI object with a given term.
<static>  
DataReader.getLocationPoint(poi, term)
Gets the point from the location of the POI object with a given term.
<static>  
DataReader.getLocationPolygon(poi, term)
Gets the polygons from the location of the POI object with a given term.
<static>  
DataReader.getOccupation(poi, lang)
Gets the occupation description from the POI object with a given language.
<static>  
DataReader.getPrice(poi, lang)
Gets a price description from the POI object with a given language.
<static>  
DataReader.getRelationshipBase(poi, term)
Gets the relationship base with a given term from the POI object.
<static>  
DataReader.getRelationshipId(poi, term)
Gets the relationship id with a given term from the POI object.
<static>  
DataReader.getThumbnails(poi)
Gets all the thumbnail URI or base-64 bytecode from the POI object.
<static>  
DataReader.getWaitingTime(poi)
Gets the waiting time description from the POI object with a given language.
<static>  
DataReader.setDefaultLanguage(lang)
Sets the DataReader default language.
Class Detail
DataReader()
Method Detail
<static> {String[]} DataReader.getAvailableLanguages(poi, field)
Gets the available languages for the POI object.
Parameters:
poi
a single POI object (such as a Point Of Interest, Route or Event).
field
specifies the field to be checked (either label or description).
Returns:
{String[]} an array containing the available languages of a given field.

<static> {String} DataReader.getCalendar(poi, term)
Gets the calendar with a given term from the POI object.
Parameters:
poi
a single POI object (such as a Point Of Interest, Route or Event).
term
the wanted term (see term)
Returns:
{String} the calendar in iCalendar format with the given term or false.

<static> {String} DataReader.getCategories(poi, lang)
Gets the categories in a given language.
Parameters:
poi
the object to get the data.
lang
the wanted language.
Returns:
{String} a list containing the following: the categories in the desired language if none found or empty.

<static> {String} DataReader.getContacts(poi)
Gets the contacts from the POI object.
Parameters:
poi
a single POI object (such as a Point Of Interest, Route or Event).
Returns:
{String} the contacts in vCard format or false.

<static> {String} DataReader.getDescription(poi, lang)
Gets a given description from the POI object with a given language.
Parameters:
poi
a single POI object (such as a Point Of Interest, Route or Event).
lang
the wanted language.
Returns:
{String} a description in a given language, or in en_GB if the wanted language does not exist or false if both do not exist.

<static> {ImageContent[]} DataReader.getImagesUri(poi)
Gets all image URI from the link section of the POI object.
Parameters:
poi
a single POI object (such as a Point Of Interest, Route or Event).
Returns:
{ImageContent[]} an array of image URI or an empty list.

<static> {String} DataReader.getLabel(poi, term, lang)
Gets a label description from the POI object with a given term in a given language.
Parameters:
poi
a single POI object (such as a Point of Interest, Route or Event).
term
the wanted term (see term).
lang
the wanted language.
Returns:
{String} a label description corresponding to the term in a given language, or en_GB if the wanted language does not exist or false if both do not exist.

<static> {String} DataReader.getLink(poi, term)
Gets a given link with a given term from the POI object.
Parameters:
poi
the object to get the data.
term
the term used - see term
Returns:
{String} the link with the given term or null if none was found.

<static> {String} DataReader.getLocalLanguage()
Gets the local language and country.
Returns:
{String} the local language in the following format lang_COUNTRY (e.g.: pt_PT) or just "en" if it was not possible to get it.

<static> {GeometryContent[]} DataReader.getLocationGeometry(poi, term)
Gets all geometries from the location of the POI object with a given term.
Parameters:
poi
a single POI object (such as a Point Of Interest, Route or Event).
term
the wanted term.
Returns:
{GeometryContent[]} an array containing all geometries with the given term or an empty array.

<static> {LineContent[]} DataReader.getLocationLine(poi, term)
Gets the lines from the location of the POI object with a given term.
Parameters:
poi
a single POI object (such as a Point Of Interest, Route or Event).
term
the wanted term.
Returns:
{LineContent[]} an array containing all lines with the given term or an empty array.

<static> {PointContent[]} DataReader.getLocationPoint(poi, term)
Gets the point from the location of the POI object with a given term.
Parameters:
poi
a single POI object (such as a Point Of Interest, Route or Event).
term
the wanted term.
Returns:
{PointContent[]} an array containing all points with the given term or an empty array.

<static> {PolygonContent[]} DataReader.getLocationPolygon(poi, term)
Gets the polygons from the location of the POI object with a given term.
Parameters:
poi
a single POI object (such as a Point Of Interest, Route or Event).
term
the wanted term.
Returns:
{PolygonContent[]} an array containing all polygons with the given term or an empty array.

<static> {String} DataReader.getOccupation(poi, lang)
Gets the occupation description from the POI object with a given language.
Parameters:
poi
a single POI object (such as a Point Of Interest, Route or Event).
lang
Returns:
{String} the occupation description (0 to 100) or false.

<static> {String} DataReader.getPrice(poi, lang)
Gets a price description from the POI object with a given language.
Parameters:
poi
a single POI object (such as a Point Of Interest, Route or Event).
lang
the wanted language.
Returns:
{String} a price description in the given language, or in en_GB if the wanted language does not exist or false if both do not exist.

<static> {String} DataReader.getRelationshipBase(poi, term)
Gets the relationship base with a given term from the POI object.
Parameters:
poi
the object to get the data.
term
the term used (see term).
Returns:
{String} the relationship base with the given term or false if none was found.

<static> {String} DataReader.getRelationshipId(poi, term)
Gets the relationship id with a given term from the POI object.
Parameters:
poi
the object to get the data.
term
the term used (see term).
Returns:
{String} the relationship id with the given term or false if none was found.

<static> {ImageContent[]} DataReader.getThumbnails(poi)
Gets all the thumbnail URI or base-64 bytecode from the POI object.
Parameters:
poi
a single POI object (such as a Point Of Interest, Route or Event).
Returns:
{ImageContent[]} all the thumbnail URI or base-64 bytecode or an empty list.

<static> {String} DataReader.getWaitingTime(poi)
Gets the waiting time description from the POI object with a given language.
Parameters:
poi
a single POI object (such as a Point Of Interest, Route or Event).
Returns:
{String} the waiting time description (in seconds) or false.

<static> DataReader.setDefaultLanguage(lang)
Sets the DataReader default language. Default: en_GB
Parameters:
lang
the new default language.

Documentation generated by JsDoc Toolkit 2.4.0 on Tue Jul 02 2013 13:20:48 GMT+0100 (WEST)