Plasma/Transport públic/Crear proveïdors de serveis

Crear un nou proveïdor de serveis

Els noms dels fitxers comencen amb el codi del país seguit d'un guió baix i un nom curt (i l'extensió, és clar). El nom del fitxer comença amb el codi de país o «international» o «unknown» seguit de «_» i un nom curt del proveïdor de serveis, per exemple, «de_db», «ch_sbb», «sk_atlas», «international_flightstats». El fitxer XML acaba amb «. xml».

El fitxer XML

Els enllaços als fitxers XML per al fitxer script que s'ha d'utilitzar i contindrà un «url pur», en aquest es pot inserir el nom de la parada i altra informació.

El fitxer script

El fitxer script ha de contenir almenys una funció anomenada «parseTimetable», amb un argument. Tot el cos HTML anirà a l'script a través d'aquest argument. És llavors quan l'script analitza el document. Tot seguit us oferim una llista de funcions que criden al motor de dades PublicTransport per que s'analitzi un document:

• parseTimetable( html ) (Usat per analitzar la sortida/arribada dels documents).
• parseJourneys( html ) (Usat per analitzar els documents de viatge).
• parsePossibleStops( html ) (Usat per analitzar els documents de suggeriment de parades).

Funcions auxiliars

Aquest és un objecte d'ajuda anomenat «helper», que pot ser utilitzat per l'script. Té les següents funcions:

• trim( string ) (Elimina « » del principi i el final de la cadena donada).
• stripTags( string ) (Elimina totes les etiquetes de la cadena donada, és a dir, elimina <...> o </...>).
• camelCase( string ) (El primer caràcter de cada paraula serà en majúscula, totes les altres en minúscules).
• extractBlock( string, beginString, endString ) (Retorna la cadena entre la primera aparició de beginString i la primera aparició de endString, o una cadena buida si beginString o endString no s'ha pogut trobar a la cadena. Per exemple, extractBlock("<b>Bold Text</b>", "<b>", "</b>") retorna "Bold Text").
• matchTime( string, formatString ) (Cerca una cadena d'hora en el format donat, per exemple, «hh:mm» retorna una llista amb dos nombres enters, l'hora i els minuts).
• formatTime( hour, minute, formatString ) (Dóna format a l'hora donada amb el formatString determinat).
• duration( sTime1, sTime2, formatString ) (Torna la durada en minuts de sTime1 a sTime2, que són cadenes d'hora en el formatString determinat).
• addMinsToTime( sTime, minsToAdd, formatString ) (Analitza l'hora amb el formatString determinat, afegeix minuts amb minsToAdd i especifica altra vegada el format utilitzant formatString).
• splitSkipEmptyParts( string, separator ) (Divideix la cadena donada utilitzant el separador indicat, mentre que omet les parts buides).

Afegir sortides analitzades per al conjunt de resultats

Aquest és un objecte anomenat «timetableData» donat a l'script. Per afegir una sortida analitzada al conjunt de resultats feu alguna cosa com això:

// Add departure
 timetableData.clear();
 timetableData.set( 'TransportLine', 'N6' );
 timetableData.set( 'TypeOfVehicle', 'STR' );
 timetableData.set( 'Target', 'Bremen Hbf' );
 timetableData.set( 'DepartureHour', 1 );
 timetableData.set( 'DepartureMinute', 30 );
 result.addData( timetableData );

Això afegeix un punt de sortida de la línia de tramvia «N6», sortint a les 01:30 amb la destinació «Bremen Hbf».

Tipus d'Informació

Aquí teniu una llista de tots els tipus d'informació que es pot afegir a l'objecte timetableData per a sortida, arribada i viatge:

• DepartureDate: La data de la sortida.
• DepartureHour: Obligatori per a les sortides, arribades i viatges. L'hora de la sortida.
• DepartureMinute: Obligatori per a les sortides, arribades i viatges. El minut de la sortida.
• TransportLine: Obligatori per a les sortides i arribades. El nom de la línia de transport públic, per exemple, «4», «6S», «S 5», «RB 24122».
• Target: Obligatori per a les sortides i arribades. La destinació d'un viatge / d'una línia de transport públic.
• TypeOfVehicle: El tipus de vehicle.
• FlightNumber: Igual que TransportLine, utilitzat per a vols.
• Platform: La plataforma en la qual el vehicle surt/arriba.
• Delay: El retard d'un vehicle de transport públic.
• DelayReason: El motiu d'un retard.
• JourneyNews: Pot contenir retard / motiu del retard / altres notícies.
• JourneyNewsOther: Altres notícies (sense retard / motiu del retard).
• JourneyNewsLink: Conté un enllaç a una pàgina html amb notícies de viatge. L'url de l'accés s'anteposa, si coincideix un camí relatiu (començarà amb «/»).
• DepartureHourPrognosis: El pronòstic per a l'hora de sortida, la qual serà l'hora de sortida més el retard.
• DepartureMinutePrognosis: El pronòstic per als minuts de l'hora de sortida, la qual serà l'hora de sortida més els minuts de retard.
• Operator: L'empresa que s'encarrega del viatge.
• DepartureAMorPM: S'utilitza per a la cadena «am» o «pm» per a l'hora de sortida.
• DepartureAMorPMPrognosis: S'utilitza per a la cadena «am» o «pm» per al pronòstic de l'hora de sortida.
• ArrivalAMorPM: S'utilitza per a la cadena «am» o «pm» per a l'hora d'arribada.
• Status: L'estat actual de la sortida/arribada. Actualment només s'utilitza per als avions.
• DepartureYear: L'any de la sortida, a utilitzar quan l'any se separa de la data.
• RouteStops: Una llista de les parades de sortida/arribada fins a la vostra parada de destí o una llista de les parades del viatge des del seu inici fins a la parada de destí. Si RouteStops i RouteTimes estan establerts, hauran de contenir el mateix nombre d'elements. I els elements amb els índexs d'igualtat han d'estar associats (les hores en què el vehicle arriba a les parades). Per a viatges s'ha d'utilitzar RouteTimesDeparture i RouteTimesArrival en comptes de RouteTimes.
• RouteTimes: Una llista de l'horari de sortida/arribada a la parada de destí. Si RouteStops i RouteTimes estan establerts, hauran de contenir el mateix nombre d'elements. I els elements amb els índexs d'igualtat han d'estar associats (les hores en què el vehicle arriba a les parades).
• RouteTimesDeparture: Una llista de l'horari de sortida del viatge. Si RouteStops i RouteTimesDeparture estan establerts, hauran de contenir un elements menys (perquè l'última parada no té sortida, només una hora d'arribada). Els elements amb els índexs d'igualtat han d'estar associats (les hores en què el vehicle surt de les parades).
• RouteTimesArrival: Una llista de l'horari d'arribada del viatge. Si RouteStops i RouteTimesArrival estan establerts, hauran de contenir un elements menys (perquè la primera parada no té arribada, només una hora de sortida). Els elements amb els índexs d'igualtat han d'estar associats (les hores en què el vehicle arriba a les parades).
• RouteExactStops: El nombre exacte de parades en una ruta. La llista de parades en la ruta no està completa fins a l'última parada de la ruta.
• RouteTypesOfVehicles: Els tipus de vehicles utilitzats per a cada «sub-viatge» d'un viatge.
• RouteTransportLines: Les línies de transport utilitzades per a cada «sub-viatge» d'un viatge.
• RoutePlatformsDeparture: Les plataformes de sortides per a cada «sub-viatge» d'un viatge.
• RoutePlatformsArrival: Les plataformes d'arribades per a cada «sub-viatge» d'un viatge.
• RouteTimesDepartureDelay: Una llista dels retards en minuts per a cada hora de sortida d'una ruta (RouteTimesDeparture).
• RouteTimesArrivalDelay: Una llista dels retards en minuts per cada hora d'arribada d'una ruta (RouteTimesArrival).

Aquests elements d'informació només s'apliquen als viatges:

• Duration (La durada d'un viatge).
• StartStopName (El nom de la parada de sortida d'un viatge).
• StartStopID (L'identificador de l'estació de sortida d'un viatge).
• TargetStopName (El nom de la parada de destí d'un viatge).
• TargetStopID (L'identificador de la parada de destí d'un viatge).
• ArrivalDate (La data de l'arribada).
• ArrivalHour (Obligatòria per als viatges. L'hora d'arribada).
• ArrivalMinute (Obligatòria per als viatges. El minut de l'arribada).
• Changes (El nombre de canvis entre diferents vehicles en un viatge).
• TypesOfVehicleInJourney (Una llista dels tipus de vehicles utilitzats en un viatge).
• Pricing (Informació sobre el preu d'un viatge).

Aquests elements d'informació només s'apliquen a suggeriments de parades:

• StopName (Obligatori per a suggeriments de parades. Serà el nom d'una parada/estació).
• StopID (Serà l'identificador d'una parada/estació).
• StopWeight (Serà el pes en rellevància per a un suggeriment de parada).

Informació

Més endavant hi haurà plantilles per a un fitxer XML i script. Fins llavors, podeu fer una ullada als proveïdors de serveis existents.