Package org.apache.sis.storage
Class DataStoreException
- All Implemented Interfaces:
- Serializable,- LocalizedException
- Direct Known Subclasses:
- CanNotProbeException,- ConcurrentReadException,- ConcurrentWriteException,- DataStoreClosedException,- DataStoreContentException,- DataStoreReferencingException,- ForwardOnlyStorageException,- IllegalFeatureTypeException,- IllegalOpenParameterException,- IncompatibleResourceException,- InternalDataStoreException,- NoSuchDataException,- ReadOnlyStorageException,- ResourceAlreadyExistsException,- UnsupportedQueryException
Thrown when a 
DataStore cannot complete a read or write operation.
 Localization
ThegetMessage() and getLocalizedMessage() methods return the same message,
 but sometimes in different languages. The general policy is that getMessage() returns
 the message in the JVM default locale while getLocalizedMessage()
 returns the message in the locale specified by the last call to DataStore.setLocale(Locale).
 In a client-server architecture, the former is typically the locale of the system administrator
 while the latter is presumably the locale of the client connected to the server.
 However, this policy is applied on a best-effort basis only.- Since:
- 0.3
- See Also:
Defined in the sis-storage module
- 
Constructor SummaryConstructorsConstructorDescriptionCreates an exception with no cause and no details message.DataStoreException(String message) Creates an exception with the specified details message.DataStoreException(String message, Throwable cause) Creates an exception with the specified details message and cause.DataStoreException(Throwable cause) Creates an exception with the specified cause and no details message.DataStoreException(Locale locale, String format, String filename, Object store) Creates a localized exception with a message saying that the given store cannot be processed.
- 
Method SummaryModifier and TypeMethodDescriptionIf this exception is capable to return the message in various locales, returns that message.Returns a localized version of the exception message, typically for final user.Returns the exception message in the default locale, typically for system administrator.initCause(Throwable cause) Initializes the cause of this throwable to the specified value.Methods inherited from class ThrowableaddSuppressed, fillInStackTrace, getCause, getStackTrace, getSuppressed, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
- 
Constructor Details- 
DataStoreExceptionpublic DataStoreException()Creates an exception with no cause and no details message.
- 
DataStoreExceptionCreates an exception with the specified details message.- Parameters:
- message- the detail message in the default locale.
 
- 
DataStoreExceptionCreates an exception with the specified cause and no details message.- Parameters:
- cause- the cause for this exception.
 
- 
DataStoreExceptionCreates an exception with the specified details message and cause.- Parameters:
- message- the detail message in the default locale.
- cause- the cause for this exception.
 
- 
DataStoreExceptionCreates a localized exception with a message saying that the given store cannot be processed. Location in the file where the error occurred while be fetched from the givenstoreargument if possible, for example by invoking theLineNumberReader.getLineNumber()orXMLStreamReader.getLocation()method. If the givenstoreargument is not one of the recognized types, then it is ignored.Examples of messages created by this constructor: - Cannot read “Foo” as a file in the Bar format.
- Cannot read after column 10 or line 100 of “Foo” as part of a file in the Bar format.
 - Parameters:
- locale- the locale of the message to be returned by- getLocalizedMessage(), or- null.
- format- short name or abbreviation of the data format (e.g. "CSV", "GML", "WKT", etc).
- filename- name of the file or data store where the error occurred.
- store- the input or output object from which to get the current position, or- nullif none. This can be a- LineNumberReaderor- XMLStreamReaderfor example.
- Since:
- 0.8
 
 
- 
- 
Method Details- 
getMessageReturns the exception message in the default locale, typically for system administrator.- Specified by:
- getMessagein interface- LocalizedException
- Overrides:
- getMessagein class- Throwable
- Returns:
- the message of this exception.
 
- 
getLocalizedMessageReturns a localized version of the exception message, typically for final user. This is often the same message than the one returned bygetMessage(), but may in some occasions be different ifDataStore.setLocale(Locale)has been invoked with a different locale.
WhengetMessage()versusgetLocalizedMessage()getMessage()andgetLocalizedMessage()are not equivalent, the Apache SIS policy is thatgetMessage()returns the message in the default locale whilegetLocalizedMessage()returns the message in a locale that depends on the context in which the exception has been thrown. In a client-server architecture, the former is often the locale on the server side while the latter is the locale on the client side if that information has been provided to theDataStore.- Specified by:
- getLocalizedMessagein interface- LocalizedException
- Overrides:
- getLocalizedMessagein class- Throwable
- Returns:
- the localized message of this exception.
- Since:
- 0.8
- See Also:
 
- 
getInternationalMessageIf this exception is capable to return the message in various locales, returns that message. Otherwise returnsnull.- Specified by:
- getInternationalMessagein interface- LocalizedException
- Returns:
- the exception message, or nullif this exception cannot produce international message.
- Since:
- 0.8
 
- 
initCauseInitializes the cause of this throwable to the specified value.- Overrides:
- initCausein class- Throwable
- Parameters:
- cause- the cause saved for later retrieval by the- Throwable.getCause()method.
- Returns:
- a reference to this DataStoreExceptioninstance.
- Since:
- 0.8
 
 
-