Package org.jbehave.core.io.rest

Class IndexWithBreadcrumbs

java.lang.Object

org.jbehave.core.io.rest.IndexWithBreadcrumbs

All Implemented Interfaces:

ResourceIndexer

Direct Known Subclasses:

IndexFromRedmine, IndexFromXWiki

public abstract class IndexWithBreadcrumbs
extends Object
implements ResourceIndexer

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	IndexWithBreadcrumbs.ToLowerCase

Constructor Summary

Constructors

Constructor	Description
IndexWithBreadcrumbs(RESTClient client, ResourceNameResolver nameResolver)

Method Summary

Modifier and Type	Method	Description
protected void	addBreadcrumbs(Map<String,Resource> index)
protected abstract Map<String,Resource>	createIndexFromEntity(String rootURI, String entity)
protected Map<String,Resource>	createIndexFromPaths(String rootURI, String rootPath, String syntax, String includes)
Map<String,Resource>	indexResources(String rootURI)	Indexes resources retrieved from the given root URI
Map<String,Resource>	indexResources(String rootURI, String rootPath, String syntax, String includes)	Indexes resources found in the given root path
protected String	resolveName(String input)
protected abstract String	uri(String rootPath)

Methods inherited from class java.lang.Object

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

Constructor Detail

IndexWithBreadcrumbs

public IndexWithBreadcrumbs(RESTClient client,
                            ResourceNameResolver nameResolver)

Method Detail

indexResources

public Map<String,Resource> indexResources(String rootURI)

Description copied from interface: ResourceIndexer

Indexes resources retrieved from the given root URI

Specified by:

indexResources in interface ResourceIndexer

Parameters:

rootURI - the root URI

Returns:

The Map of index Resource objects

indexResources

public Map<String,Resource> indexResources(String rootURI,
                                                 String rootPath,
                                                 String syntax,
                                                 String includes)

Description copied from interface: ResourceIndexer

Indexes resources found in the given root path

Specified by:

indexResources in interface ResourceIndexer

Parameters:

rootURI - the root URI

rootPath - the root path of the resources to index

syntax - the syntax of the resources to index. Can be null or blank.

includes - the Ant-like pattern of the paths to index. Can be null or blank.

Returns:

The Map of index Resource objects

createIndexFromPaths

protected Map<String,Resource> createIndexFromPaths(String rootURI,
                                                          String rootPath,
                                                          String syntax,
                                                          String includes)

addBreadcrumbs

protected void addBreadcrumbs(Map<String,Resource> index)

createIndexFromEntity

protected abstract Map<String,Resource> createIndexFromEntity(String rootURI,
                                                                    String entity)

uri

protected abstract String uri(String rootPath)

resolveName

protected String resolveName(String input)