Package nz.org.riskscape.engine.data

Interface BookmarkResolvers

All Superinterfaces:

IdentifiedCollection<BookmarkResolver>

public interface BookmarkResolvers
extends IdentifiedCollection<BookmarkResolver>

Nested Class Summary

Nested classes/interfaces inherited from interface nz.org.riskscape.engine.IdentifiedCollection

IdentifiedCollection.Base<T extends Identified>

Method Summary

Modifier and Type	Method	Description
<T> ResultOrProblems<T>	getData(Bookmark bookmark, BindingContext context, Class<T> requiredType)	Resolves a Bookmark and fetches the data from the ResolvedBookmark.
default List<String>	getSupportedFormats()
ResultOrProblems<ResolvedBookmark>	resolve(Bookmark bookmark, BindingContext context)	Resolves a Bookmark without doing any error checking beyond asserting that a BookmarkResolver appears to be able to access the data behind this Bookmark.
ResultOrProblems<ResolvedBookmark>	resolveAndValidate(Bookmark bookmark, BindingContext context, Class<?> requiredType)	Alternative to getData that returns the ResolvedBookmark rather than the given data.

Methods inherited from interface nz.org.riskscape.engine.IdentifiedCollection

add, add, add, addAll, addAll, clear, containsKey, get, get, getAll, getAllProblems, getCollectionClass, getOr, getReferences, getResult, getSimilarIds, isEmpty, remove

Method Details

resolve

ResultOrProblems<ResolvedBookmark> resolve(Bookmark bookmark,
 BindingContext context)

Resolves a Bookmark without doing any error checking beyond asserting that a BookmarkResolver appears to be able to access the data behind this Bookmark.

getData

<T> ResultOrProblems<T> getData(Bookmark bookmark,
 BindingContext context,
 Class<T> requiredType)

Resolves a Bookmark and fetches the data from the ResolvedBookmark.

Parameters:

bookmark - to resolve

context - to bind any bookmark parameters with

Returns:

the result of ResolvedBookmark.getData(Class), or empty if the data can not be accessed from the ResolvedBookmark. Any problems will be wrapped with a foundWith problem with the bookmark as context

resolveAndValidate

ResultOrProblems<ResolvedBookmark> resolveAndValidate(Bookmark bookmark,
 BindingContext context,
 Class<?> requiredType)

Alternative to getData that returns the ResolvedBookmark rather than the given data. The data is still accessed, and any errors fetching it will be returned instead of the ResolvedBookmark.

Returns:

Any problems will be wrapped with a foundWith problem with the bookmark as context

getSupportedFormats

default List<String> getSupportedFormats()

Returns:

A list of all the supported bookmark formats