Package org.apache.sis.io.wkt
Class Warnings
Object
Warnings
- All Implemented Interfaces:
- Serializable,- Localized
Warnings that occurred during a Well Known Text (WKT) parsing or formatting.
 Information provided by this object include:
 
- Recoverable exceptions.
- At formatting time, object that cannot be formatted in a standard-compliant WKT.
- At parsing time, unknown keywords.
Example: after parsing the following WKT:
 
GeographicCRS[“WGS 84”,
  Datum[“World Geodetic System 1984”,
    Ellipsoid[“WGS84”, 6378137.0, 298.257223563, Intruder[“some text here”]]],
    PrimeMeridian[“Greenwich”, 0.0, Intruder[“other text here”]],
  AngularUnit[“degree”, 0.017453292519943295]]WKTFormat.getWarnings() would return a Warnings instance with the following information:
 - getRootElement()returns- "WGS 84",
- getUnknownElements()returns- {"Intruder"}, and
- getUnknownElementLocations("Intruder")returns- {"Ellipsoid", "PrimeMeridian"}.
- Since:
- 0.6
- See Also:
Defined in the sis-referencing module
- 
Method SummaryModifier and TypeMethodDescriptiongetException(int index) Returns the exception which was the cause of the message at the given index, ornullif none.Returns the non-fatal exceptions that occurred during the parsing or formatting.String[]Returns the keywords of the WKT element where the given exception occurred, ornullif unknown.Returns the locale in which warning messages are reported by the defaulttoString()method.getMessage(int index) Returns a warning message.final intReturns the number of warning messages.Returns the name of the root element being parsed or formatted.getUnknownElementLocations(String element) Returns the keyword of WKT elements that contains the given unknown element.Returns the keywords of all unknown elements found during the WKT parsing.Returns a string representation of the warning messages in the formatter locale.Returns a string representation of the warning messages in the given locale.
- 
Method Details- 
getLocaleReturns the locale in which warning messages are reported by the defaulttoString()method. This is not necessarily the same locale than the one used for parsing and formatting dates and numbers in the WKT.- Specified by:
- getLocalein interface- Localized
- Returns:
- the locale or warning messages are reported.
 
- 
getRootElementReturns the name of the root element being parsed or formatted. If the parsed of formatted object implement theIdentifiedObjectinterface, then this method returns the value ofIdentifiedObject.getName().getCode(). Otherwise this method returns a simple class name.- Returns:
- the name of the root element, or nullif unknown.
 
- 
getNumMessagespublic final int getNumMessages()Returns the number of warning messages.- Returns:
- the number of warning messages.
 
- 
getMessageReturns a warning message.- Parameters:
- index- 0 for the first warning, 1 for the second warning, etc. until- getNumMessages()- 1.
- Returns:
- the i-th warning message.
 
- 
getExceptionReturns the exception which was the cause of the message at the given index, ornullif none.- Parameters:
- index- the value given to- getMessage(int).
- Returns:
- the exception which was the cause of the warning message, or nullif none.
 
- 
getExceptionsReturns the non-fatal exceptions that occurred during the parsing or formatting. If no exception occurred, returns an empty set.- Returns:
- the non-fatal exceptions that occurred.
 
- 
getExceptionSourceReturns the keywords of the WKT element where the given exception occurred, ornullif unknown. If this method returns a non-null array, thensource[0]is the keyword of the WKT element where the exception occurred andsource[1]is the keyword of the parent ofsource[0].Note: in other words, this method returns the tail of the path to the WKT element where the exception occurred, but with path elements stored in reverse order.- Parameters:
- ex- the exception for which to get the source.
- Returns:
- the keywords of the WKT element where the given exception occurred, or nullif unknown.
 
- 
getUnknownElementsReturns the keywords of all unknown elements found during the WKT parsing.- Returns:
- the keywords of unknown WKT elements, or an empty set if none.
 
- 
getUnknownElementLocationsReturns the keyword of WKT elements that contains the given unknown element. If the given element is not one of the value returned bygetUnknownElements(), then this method returnsnull.The returned collection elements are in no particular order. - Parameters:
- element- the keyword of the unknown element.
- Returns:
- the keywords of elements where the given unknown element was found.
 
- 
toStringReturns a string representation of the warning messages in the formatter locale. The locale used by this method is given bygetLocale().
- 
toStringReturns a string representation of the warning messages in the given locale. This method formats the warnings in a bullet list.- Parameters:
- locale- the locale to use for formatting warning messages.
- Returns:
- a string representation of the warning messages.
 
 
-