com.epimorphics.lda.renderers.common

Class Page

java.lang.Object

com.epimorphics.rdfutil.RDFNodeWrapper

com.epimorphics.lda.renderers.common.CommonNodeWrapper

com.epimorphics.lda.renderers.common.Page

public class Page
extends CommonNodeWrapper

Value object representing the page of results returned by Elda's query processing. Corresponds to a single resource of type api:Page.

Author:

Ian Dickinson, Epimorphics (mailto:ian@epimorphics.com)

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_VIEW_NAME By default, we assume we're seeing the basic view
static int	NO_VALUE Indicate no available numeric value

Fields inherited from class com.epimorphics.rdfutil.RDFNodeWrapper

modelw, node

Constructor Summary

Constructors

Constructor and Description
Page(com.epimorphics.rdfutil.ModelWrapper mw, com.hp.hpl.jena.rdf.model.Resource root) Construct a new page object corresponding to the root object in model mw.

Method Summary

Methods

Modifier and Type	Method and Description
protected Link	createRemovalLink(EldaURL pageURL, String paramName, String paramHTML, String paramValue, String paramValueHTML)
List<PropertyPath>	currentPropertyPaths() Return a list of all of the property paths that are explicitly defined for this page.
EldaView	currentView() Return the current view, if we can determine what it is.
com.hp.hpl.jena.rdf.model.Resource	definition()
String	extendedMetadataURL()
List<Link>	filterRemovalLinks()
EldaView	findViewByName(String viewName) Return the view that has the given name
com.hp.hpl.jena.rdf.model.Resource	firstPage()
List<PageFormat>	formats()
boolean	hasPageData()
void	initialiseShortNameRenderer(ShortnameService sns) Initialise the short-name renderer that this page has access to, basing it on an existing short name service
boolean	isItemEndpoint()
com.hp.hpl.jena.rdf.model.Resource	isPartOf()
boolean	itemHasAllProperties(List<Object> properties)
boolean	itemHasAllProperties(Object... properties)
List<DisplayRdfNode>	items()
int	itemsPerPage()
com.hp.hpl.jena.rdf.model.Resource	lastPage()
PageMetadata	metadata() Return a facade object providing a convenience API onto the page metadata
com.hp.hpl.jena.rdf.model.Resource	nextPage()
int	pageNumber()
String	pageTitle() Synthesise an informative title for this page
EldaURL	pageURL()
com.hp.hpl.jena.rdf.model.Resource	prevPage()
protected List<PropertyPath>	queryParamPropertyPaths()
List<DisplayRdfNode>	resourcesWithAllProperties(List<Object> properties)
ShortNameRenderer	shortNameRenderer()
List<Link>	sortRemovalLinks()
int	startIndex()
List<Binding<com.hp.hpl.jena.rdf.model.Resource>>	termBindings() Return a list of the term bindings, which associate a short name with a resource.
List<Binding<String>>	varBindings() Return a list of the variable bindings, which associate a variable name with a textual value
Map<String,String>	varBindingsMap()
List<EldaView>	views()

Methods inherited from class com.epimorphics.lda.renderers.common.CommonNodeWrapper

getInt, getResource, isXmlLiteral, page

Methods inherited from class com.epimorphics.rdfutil.RDFNodeWrapper

asList, asLiteral, asRDFNode, asResource, asTurtle, asTurtle, closure, closure, connectedNodes, equals, firstValueOf, get, getDatatype, getLanguage, getLexicalForm, getLocalizedValue, getModelW, getName, getPropertyValue, getShortURI, getURI, getValue, hashCode, hasResourceValue, isAnon, isList, isLiteral, isResource, listInLinks, listInLinks, listProperties, listPropertyValues, tokeniseWords, toProperty, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

NO_VALUE

public static final int NO_VALUE

Indicate no available numeric value

See Also:

Constant Field Values

DEFAULT_VIEW_NAME

public static final String DEFAULT_VIEW_NAME

By default, we assume we're seeing the basic view

See Also:

Constant Field Values

Constructor Detail

Page

public Page(com.epimorphics.rdfutil.ModelWrapper mw,
    com.hp.hpl.jena.rdf.model.Resource root)

Construct a new page object corresponding to the root object in model mw.

Parameters:

mw - A wrapper around the model containing the results from the API

root - The root resource of this page

Method Detail

initialiseShortNameRenderer

public void initialiseShortNameRenderer(ShortnameService sns)

Initialise the short-name renderer that this page has access to, basing it on an existing short name service

Parameters:

sns -

shortNameRenderer

public ShortNameRenderer shortNameRenderer()

Returns:

The short name renderer for this page

pageURL

public EldaURL pageURL()

Returns:

The page URL in a form that supports generating related URLs

isItemEndpoint

public boolean isItemEndpoint()

Returns:

True if the page denotes a single item, or false for a list endpoint

pageNumber

public int pageNumber()

Returns:

The current page number, starting from zero. Return -1 if this page does not have a specified page number

itemsPerPage

public int itemsPerPage()

Returns:

The number of items per page. Return -1 if this page does not specify the number of items per page

startIndex

public int startIndex()

Returns:

The starting index for this page, starting from one. Return -1 if this page does not specify the starting index.

isPartOf

public com.hp.hpl.jena.rdf.model.Resource isPartOf()

Returns:

The list that this page is part of

definition

public com.hp.hpl.jena.rdf.model.Resource definition()

Returns:

A resource denoting the API endpoint specification.

extendedMetadataURL

public String extendedMetadataURL()

Returns:

The URL for the extended metadata for this page

firstPage

public com.hp.hpl.jena.rdf.model.Resource firstPage()

Returns:

The resource denoting the first page of results, or null

prevPage

public com.hp.hpl.jena.rdf.model.Resource prevPage()

Returns:

The resource denoting the previous page of results, or null

nextPage

public com.hp.hpl.jena.rdf.model.Resource nextPage()

Returns:

The resource denoting the next page of results, or null

lastPage

public com.hp.hpl.jena.rdf.model.Resource lastPage()

Returns:

The resource denoting the last page of results, or null

hasPageData

public boolean hasPageData()

Returns:

True if this page of results has at least one element of related page data

formats

public List<PageFormat> formats()

Returns:

A list of the formats that this page is available in

views

public List<EldaView> views()

Returns:

A list of the views that this page defines

termBindings

public List<Binding<com.hp.hpl.jena.rdf.model.Resource>> termBindings()

Return a list of the term bindings, which associate a short name with a resource.

Returns:

A list of the term bindings defined on this page

varBindings

public List<Binding<String>> varBindings()

Return a list of the variable bindings, which associate a variable name with a textual value

Returns:

A list of the variable bindings

varBindingsMap

public Map<String,String> varBindingsMap()

Returns:

The varBindings() as a map. Cached for performance.

items

public List<DisplayRdfNode> items()

Returns:

A list of the items on this page, as a list of DisplayRdfNode

currentView

public EldaView currentView()

Return the current view, if we can determine what it is. If we can't tell from the given metadata, return the basic view.

Returns:

The currently selected view

findViewByName

public EldaView findViewByName(String viewName)

Return the view that has the given name

Parameters:

viewName - The name of the view to look for

Returns:

An EldaView object that has the name viewName

Throws:

EldaException - if there is no such view

metadata

public PageMetadata metadata()

Return a facade object providing a convenience API onto the page metadata

currentPropertyPaths

public List<PropertyPath> currentPropertyPaths()

Return a list of all of the property paths that are explicitly defined for this page. These will either be from the api:properties on the view specification, or the _properties variable, or both.

Returns:

A list of the property paths that are explicitly included in the current page.

pageTitle

public String pageTitle()

Synthesise an informative title for this page

Returns:

A displayable page title

itemHasAllProperties

public boolean itemHasAllProperties(List<Object> properties)

Returns:

True if at least one item on this page passes the hasAllProperties test with the given properties

itemHasAllProperties

public boolean itemHasAllProperties(Object... properties)

Returns:

True if at least one item on this page passes the hasAllProperties test with the given properties

resourcesWithAllProperties

public List<DisplayRdfNode> resourcesWithAllProperties(List<Object> properties)

Returns:

A list of all resources in the current results model which each have all of the given properties

filterRemovalLinks

public List<Link> filterRemovalLinks()

Returns:

A list of links to pages that remove one of the currently active filters

sortRemovalLinks

public List<Link> sortRemovalLinks()

Returns:

A list of links to pages that remove one of the currently active sorts

queryParamPropertyPaths

protected List<PropertyPath> queryParamPropertyPaths()

Returns:

A list of the property paths that were defined via the query parameter _properties

createRemovalLink

protected Link createRemovalLink(EldaURL pageURL,
                     String paramName,
                     String paramHTML,
                     String paramValue,
                     String paramValueHTML)

Returns:

A link for removing a filter or sort selection