Package de.digitalcollections.commons.file.backend.impl.resolver

Interface FileNameResolver

All Known Implementing Classes:

MultiPatternsFileNameResolverImpl, PatternFileNameResolverImpl

public interface FileNameResolver

Method Summary

Modifier and Type	Method	Description
default java.util.List<java.nio.file.Path>	getPaths(java.lang.String identifier)	Resolve the identifier to java.nio.Path objects.
default java.util.List<java.nio.file.Path>	getPaths(java.lang.String identifier, de.digitalcollections.model.api.identifiable.resource.MimeType mimeType)	Return resolved Paths that match the given MIME type.
java.util.Set<java.nio.file.Path>	getPathsForPattern(java.lang.String pattern)	Return all paths for a given pattern
java.util.List<java.lang.String>	getStrings(java.lang.String identifier)
default java.util.List<java.lang.String>	getStrings(java.lang.String identifier, de.digitalcollections.model.api.identifiable.resource.MimeType mimeType)	Return resolved strings that match the given MIME type.
default java.util.List<java.net.URI>	getUris(java.lang.String identifier)	Resolve the identifier to URI objects.
default java.util.List<java.net.URI>	getUris(java.lang.String identifier, de.digitalcollections.model.api.identifiable.resource.MimeType mimeType)	Return resolved URIs that match the given MIME type.
java.lang.Boolean	isResolvable(java.lang.String identifier)

Method Detail

isResolvable

java.lang.Boolean isResolvable(java.lang.String identifier)

getStrings

java.util.List<java.lang.String> getStrings(java.lang.String identifier)
                                     throws de.digitalcollections.model.api.identifiable.resource.exceptions.ResourceIOException

Throws:

de.digitalcollections.model.api.identifiable.resource.exceptions.ResourceIOException

getStrings

default java.util.List<java.lang.String> getStrings(java.lang.String identifier,
                                                    de.digitalcollections.model.api.identifiable.resource.MimeType mimeType)
                                             throws de.digitalcollections.model.api.identifiable.resource.exceptions.ResourceIOException

Return resolved strings that match the given MIME type.

Parameters:

identifier - file identifier/resolving key

mimeType - target mimetype (resolving subkey)

Returns:

list of resolved file uris

Throws:

de.digitalcollections.model.api.identifiable.resource.exceptions.ResourceIOException - in case getStrings for key fails

getUris

default java.util.List<java.net.URI> getUris(java.lang.String identifier)
                                      throws de.digitalcollections.model.api.identifiable.resource.exceptions.ResourceIOException

Resolve the identifier to URI objects.

Parameters:

identifier - file identifier/resolving key

Returns:

list of resolved file uris

Throws:

de.digitalcollections.model.api.identifiable.resource.exceptions.ResourceIOException - in case getStrings for key fails

getUris

default java.util.List<java.net.URI> getUris(java.lang.String identifier,
                                             de.digitalcollections.model.api.identifiable.resource.MimeType mimeType)
                                      throws de.digitalcollections.model.api.identifiable.resource.exceptions.ResourceIOException

Return resolved URIs that match the given MIME type.

Parameters:

identifier - file identifier/resolving key

mimeType - target mimetype (resolving subkey)

Returns:

list of resolved file uris

Throws:

de.digitalcollections.model.api.identifiable.resource.exceptions.ResourceIOException - in case getStrings for key fails

getPaths

default java.util.List<java.nio.file.Path> getPaths(java.lang.String identifier)
                                             throws de.digitalcollections.model.api.identifiable.resource.exceptions.ResourceIOException

Resolve the identifier to java.nio.Path objects.

Parameters:

identifier - file identifier/resolving key

Returns:

list of resolved file uris

Throws:

de.digitalcollections.model.api.identifiable.resource.exceptions.ResourceIOException - in case getStrings for key fails

getPaths

default java.util.List<java.nio.file.Path> getPaths(java.lang.String identifier,
                                                    de.digitalcollections.model.api.identifiable.resource.MimeType mimeType)
                                             throws de.digitalcollections.model.api.identifiable.resource.exceptions.ResourceIOException

Return resolved Paths that match the given MIME type.

Parameters:

identifier - file identifier/resolving key

mimeType - target mimetype (resolving subkey)

Returns:

list of resolved file uris

Throws:

de.digitalcollections.model.api.identifiable.resource.exceptions.ResourceIOException - in case getStrings for key fails

getPathsForPattern

java.util.Set<java.nio.file.Path> getPathsForPattern(java.lang.String pattern)
                                              throws de.digitalcollections.model.api.identifiable.resource.exceptions.ResourceIOException

Return all paths for a given pattern

Returns:

Throws:

de.digitalcollections.model.api.identifiable.resource.exceptions.ResourceIOException