org.codeforamerica.open311.internals.parsing
Interface DataParser

All Known Implementing Classes:

AbstractParser, JSONParser, XMLParser

public interface DataParser

Specifies required operations to the parsers.

Author:

Santiago Munín

Field Summary

static String	ACCOUNT_ID_TAG
static String	ADDRESS_ID_TAG
static String	ADDRESS_TAG
static String	AGENCY_RESPONSIBLE_TAG
static String	ATTRIBUTE_TAG
static String	ATTRIBUTES_TAG
static String	CHANGESET_TAG
static String	CODE_TAG
static String	CONTACT_TAG
static String	DATATYPE_DESCRIPTION_TAG
static String	DATATYPE_TAG
static String	DESCRIPTION_TAG
static String	DEVICE_ID_TAG
static String	DISCOVERY_TAG
static String	EMAIL_TAG
static String	END_DATE_TAG
static String	ENDPOINT_TAG
static String	ERROR_TAG
static String	EXPECTED_DATETIME_TAG
static String	FIRST_NAME_TAG
static String	FORMAT_TAG
static String	KEY_SERVICE_TAG
static String	KEY_TAG
static String	KEYWORDS_SEPARATOR
static String	KEYWORDS_TAG
static String	LAST_NAME_TAG
static String	LATITUDE_TAG
static String	LONGITUDE_TAG
static String	MEDIA_URL_TAG
static String	METADATA_TAG
static String	NAME_TAG
static String	ORDER_TAG
static String	PHONE_TAG
static String	REQUESTED_DATETIME_TAG
static String	REQUIRED_TAG
static String	SERVICE_CODE_TAG
static String	SERVICE_DEFINITION_TAG
static String	SERVICE_GROUP_TAG
static String	SERVICE_NAME_TAG
static String	SERVICE_NOTICE_TAG
static String	SERVICE_REQUEST_ID_TAG
static String	SERVICE_REQUEST_TAG
static String	SERVICE_REQUESTS_TAG
static String	SERVICE_TAG
static String	SPECIFICATION_TAG
static String	START_DATE_TAG
static String	STATUS_NOTES_TAG
static String	STATUS_TAG
static String	TEXT_FORMAT
static String	TOKEN_TAG
static String	TYPE_TAG
static String	UPDATED_DATETIME_TAG
static String	URL_TAG
static String	VALUE_TAG
static String	VALUES_TAG
static String	VARIABLE_TAG
static String	ZIPCODE_TAG

Method Summary

GeoReportV2Error	parseGeoReportV2Errors(String rawData) Parses an error and returns an object with its information.
POSTServiceRequestResponse	parsePostServiceRequestResponse(String rawData) Parses the response of a POST Service Request operation.
ServiceDefinition	parseServiceDefinition(String rawData) Parses a service definition.
ServiceDiscoveryInfo	parseServiceDiscovery(String rawData) Parses a service discovery and returns an object with its information.
List<Service>	parseServiceList(String rawData) Parses the response to the GET service list operation.
ServiceRequestIdResponse	parseServiceRequestIdFromAToken(String rawData) Parses the response to the GET service request id from a token.
List<ServiceRequest>	parseServiceRequests(String rawData) Parses a list of service requests.

Field Detail

TEXT_FORMAT

static final String TEXT_FORMAT

See Also:

Constant Field Values

SERVICE_TAG

static final String SERVICE_TAG

See Also:

Constant Field Values

SERVICE_CODE_TAG

static final String SERVICE_CODE_TAG

See Also:

Constant Field Values

SERVICE_NAME_TAG

static final String SERVICE_NAME_TAG

See Also:

Constant Field Values

DESCRIPTION_TAG

static final String DESCRIPTION_TAG

See Also:

Constant Field Values

METADATA_TAG

static final String METADATA_TAG

See Also:

Constant Field Values

TYPE_TAG

static final String TYPE_TAG

See Also:

Constant Field Values

KEYWORDS_TAG

static final String KEYWORDS_TAG

See Also:

Constant Field Values

KEYWORDS_SEPARATOR

static final String KEYWORDS_SEPARATOR

See Also:

Constant Field Values

SERVICE_GROUP_TAG

static final String SERVICE_GROUP_TAG

See Also:

Constant Field Values

SERVICE_DEFINITION_TAG

static final String SERVICE_DEFINITION_TAG

See Also:

Constant Field Values

ATTRIBUTE_TAG

static final String ATTRIBUTE_TAG

See Also:

Constant Field Values

ATTRIBUTES_TAG

static final String ATTRIBUTES_TAG

See Also:

Constant Field Values

VARIABLE_TAG

static final String VARIABLE_TAG

See Also:

Constant Field Values

CODE_TAG

static final String CODE_TAG

See Also:

Constant Field Values

DATATYPE_TAG

static final String DATATYPE_TAG

See Also:

Constant Field Values

REQUIRED_TAG

static final String REQUIRED_TAG

See Also:

Constant Field Values

DATATYPE_DESCRIPTION_TAG

static final String DATATYPE_DESCRIPTION_TAG

See Also:

Constant Field Values

ORDER_TAG

static final String ORDER_TAG

See Also:

Constant Field Values

VALUE_TAG

static final String VALUE_TAG

See Also:

Constant Field Values

VALUES_TAG

static final String VALUES_TAG

See Also:

Constant Field Values

KEY_TAG

static final String KEY_TAG

See Also:

Constant Field Values

NAME_TAG

static final String NAME_TAG

See Also:

Constant Field Values

SERVICE_REQUEST_TAG

static final String SERVICE_REQUEST_TAG

See Also:

Constant Field Values

SERVICE_REQUESTS_TAG

static final String SERVICE_REQUESTS_TAG

See Also:

Constant Field Values

TOKEN_TAG

static final String TOKEN_TAG

See Also:

Constant Field Values

SERVICE_REQUEST_ID_TAG

static final String SERVICE_REQUEST_ID_TAG

See Also:

Constant Field Values

STATUS_TAG

static final String STATUS_TAG

See Also:

Constant Field Values

STATUS_NOTES_TAG

static final String STATUS_NOTES_TAG

See Also:

Constant Field Values

AGENCY_RESPONSIBLE_TAG

static final String AGENCY_RESPONSIBLE_TAG

See Also:

Constant Field Values

SERVICE_NOTICE_TAG

static final String SERVICE_NOTICE_TAG

See Also:

Constant Field Values

REQUESTED_DATETIME_TAG

static final String REQUESTED_DATETIME_TAG

See Also:

Constant Field Values

UPDATED_DATETIME_TAG

static final String UPDATED_DATETIME_TAG

See Also:

Constant Field Values

EXPECTED_DATETIME_TAG

static final String EXPECTED_DATETIME_TAG

See Also:

Constant Field Values

ADDRESS_TAG

static final String ADDRESS_TAG

See Also:

Constant Field Values

ADDRESS_ID_TAG

static final String ADDRESS_ID_TAG

See Also:

Constant Field Values

ZIPCODE_TAG

static final String ZIPCODE_TAG

See Also:

Constant Field Values

LATITUDE_TAG

static final String LATITUDE_TAG

See Also:

Constant Field Values

LONGITUDE_TAG

static final String LONGITUDE_TAG

See Also:

Constant Field Values

MEDIA_URL_TAG

static final String MEDIA_URL_TAG

See Also:

Constant Field Values

ACCOUNT_ID_TAG

static final String ACCOUNT_ID_TAG

See Also:

Constant Field Values

ERROR_TAG

static final String ERROR_TAG

See Also:

Constant Field Values

DISCOVERY_TAG

static final String DISCOVERY_TAG

See Also:

Constant Field Values

CHANGESET_TAG

static final String CHANGESET_TAG

See Also:

Constant Field Values

CONTACT_TAG

static final String CONTACT_TAG

See Also:

Constant Field Values

KEY_SERVICE_TAG

static final String KEY_SERVICE_TAG

See Also:

Constant Field Values

SPECIFICATION_TAG

static final String SPECIFICATION_TAG

See Also:

Constant Field Values

URL_TAG

static final String URL_TAG

See Also:

Constant Field Values

FORMAT_TAG

static final String FORMAT_TAG

See Also:

Constant Field Values

ENDPOINT_TAG

static final String ENDPOINT_TAG

See Also:

Constant Field Values

START_DATE_TAG

static final String START_DATE_TAG

See Also:

Constant Field Values

END_DATE_TAG

static final String END_DATE_TAG

See Also:

Constant Field Values

EMAIL_TAG

static final String EMAIL_TAG

See Also:

Constant Field Values

DEVICE_ID_TAG

static final String DEVICE_ID_TAG

See Also:

Constant Field Values

FIRST_NAME_TAG

static final String FIRST_NAME_TAG

See Also:

Constant Field Values

LAST_NAME_TAG

static final String LAST_NAME_TAG

See Also:

Constant Field Values

PHONE_TAG

static final String PHONE_TAG

See Also:

Constant Field Values

Method Detail

parseServiceList

List<Service> parseServiceList(String rawData)
                               throws DataParsingException

Parses the response to the GET service list operation.

Parameters:

rawData - Text data.

Returns:

A list of Service objects.

Throws:

DataParsingException

parseServiceDefinition

ServiceDefinition parseServiceDefinition(String rawData)
                                         throws DataParsingException

Parses a service definition.

Parameters:

rawData - Text data.

Returns:

A service definition object.

Throws:

DataParsingException - If there was any problem parsing the data.

parseServiceRequestIdFromAToken

ServiceRequestIdResponse parseServiceRequestIdFromAToken(String rawData)
                                                         throws DataParsingException

Parses the response to the GET service request id from a token.

Parameters:

rawData - Text data.

Returns:

the given token and the service request id.

Throws:

DataParsingException - If there was any problem parsing the data.

parseServiceRequests

List<ServiceRequest> parseServiceRequests(String rawData)
                                          throws DataParsingException

Parses a list of service requests.

Parameters:

rawData - Text data.

Returns:

A list of ServiceRequest objects.

Throws:

DataParsingException - If there was any problem parsing the data.

parsePostServiceRequestResponse

POSTServiceRequestResponse parsePostServiceRequestResponse(String rawData)
                                                           throws DataParsingException

Parses the response of a POST Service Request operation.

Parameters:

rawData - Text data.

Returns:

an object containing the response information.

Throws:

DataParsingException - If there was any problem parsing the data.

parseGeoReportV2Errors

GeoReportV2Error parseGeoReportV2Errors(String rawData)
                                        throws DataParsingException

Parses an error and returns an object with its information.

Parameters:

rawData - Text data.

Returns:

Error information.

Throws:

DataParsingException - If there was any problem parsing the data.

parseServiceDiscovery

ServiceDiscoveryInfo parseServiceDiscovery(String rawData)
                                           throws DataParsingException

Parses a service discovery and returns an object with its information.

Parameters:

rawData - Text data.

Returns:

Service discovery information (endpoints and their formats).

Throws:

DataParsingException - If there was any problem parsing the data.