com.conveyal.gtfs.error

Class NewGTFSError

java.lang.Object

com.conveyal.gtfs.error.NewGTFSError

public class NewGTFSError
extends Object

TODO make hierarchy of feedError, tableError, lineError each adding fields and calling constructors. There's a good reason not to use a class hierarchy for errors: we need to instantiate errors from a database. We don't want to use reflection to call different constructors based on the error-type field in the database. We instead use an enum with final fields for severity and affected entity type.

Field Summary

Fields

Modifier and Type	Field and Description
String	badValue
String	entityId The id part of the unique key of the line containing the error (convenient but redundant info).
Integer	entitySequenceNumber The sequence number part of the unique key of the line containing the error (when needed for uniqueness).
Class<? extends Entity>	entityType The class of the table in which the error was encountered.
Map<String,String>	errorInfo Key-value pairs providing additional information about this error.
NewGTFSErrorType	errorType The kind of error encountered.
Integer	lineNumber The line of the GTFS table (one-based, including the header) on which the error was detected.

Method Summary

Modifier and Type	Method and Description
NewGTFSError	addInfo(String key, String value) Add a single key-value pair of supplemental info to this error.
static NewGTFSError	forEntity(Entity entity, NewGTFSErrorType errorType)
static NewGTFSError	forFeed(NewGTFSErrorType errorType, String badValue)
static NewGTFSError	forLine(Table table, int lineNumber, NewGTFSErrorType errorType, String badValue)
static NewGTFSError	forTable(Table table, NewGTFSErrorType errorType)
NewGTFSError	setBadValue(String badValue)
NewGTFSError	setEntityId(String entityId)
NewGTFSError	setSequence(String sequenceAsString)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

entityType

public Class<? extends Entity> entityType

The class of the table in which the error was encountered.

errorType

public final NewGTFSErrorType errorType

The kind of error encountered.

errorInfo

public Map<String,String> errorInfo

Key-value pairs providing additional information about this error.

lineNumber

public Integer lineNumber

The line of the GTFS table (one-based, including the header) on which the error was detected. It is unlikely we'll see files with over 2 billion lines (3 orders of magnitude greater than NL) so 31 bits is enough. Use Integer object rather than primitive to allow NULL because some errors affect an entire table or feed.

entityId

public String entityId

The id part of the unique key of the line containing the error (convenient but redundant info).

entitySequenceNumber

public Integer entitySequenceNumber

The sequence number part of the unique key of the line containing the error (when needed for uniqueness).

badValue

public String badValue

Method Detail

addInfo

public NewGTFSError addInfo(String key,
                            String value)

Add a single key-value pair of supplemental info to this error.

Returns:

the modified object (builder pattern that allows adding info to newly created error object without assigning to a variable).

forLine

public static NewGTFSError forLine(Table table,
                                   int lineNumber,
                                   NewGTFSErrorType errorType,
                                   String badValue)

forEntity

public static NewGTFSError forEntity(Entity entity,
                                     NewGTFSErrorType errorType)

forTable

public static NewGTFSError forTable(Table table,
                                    NewGTFSErrorType errorType)

forFeed

public static NewGTFSError forFeed(NewGTFSErrorType errorType,
                                   String badValue)

setBadValue

public NewGTFSError setBadValue(String badValue)

setEntityId

public NewGTFSError setEntityId(String entityId)

setSequence

public NewGTFSError setSequence(String sequenceAsString)