com.epimorphics.lda.core

Class View

java.lang.Object

com.epimorphics.lda.core.View

public class View
extends Object

Represents a view which selects which parts of a result resource to show, defined by a (possibly) ordered list of properties.

Version:

$Revision: $

Author:

Dave Reynolds

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	View.State
static class	View.Type

Field Summary

Fields

Modifier and Type	Field and Description
static View	ALL View that does DESCRIBE plus labels of all objects.
static View	BASIC View that does rdf:type and rdfs:label.
protected List<PropertyChain>	chains
static View	DESCRIBE View that does DESCRIBE.
protected int	describeThreshold
protected static List<PropertyChain>	emptyChain
protected String	labelPropertyURI
protected String	name
static String	SHOW_ALL
static String	SHOW_BASIC
static String	SHOW_DEFAULT_INTERNAL
static String	SHOW_DESCRIPTION
protected String	template
protected View.Type	type

Constructor Summary

Constructors

Constructor and Description
View()
View(String name)
View(String name, View.Type type)
View(String name, View.Type type, List<PropertyChain> initial)

Method Summary

Methods

Modifier and Type	Method and Description
View	addFrom(View t) Answer this view after updating it by adding all the property chains of the argument view (which must not be null).
View	addViewFromParameterValue(String prop, ShortnameService sns) Answer this view after updating it with the given property string.
View	addViewFromRDFList(com.hp.hpl.jena.rdf.model.Resource spec, ShortnameService sns) Answer this view after modifying it to contain all the property chains defined by spec.
Set<PropertyChain>	chains()
View	copy() Answer this view if it is ALL, otherwise a new view that does the same filtering and is mutable without affecting the original.
static String	createDescribeQueryForItems(View.State s, List<com.hp.hpl.jena.rdf.model.Resource> allRoots)
boolean	equals(Object other)
String	fetchDescriptions(Controls c, View.State s)
String	fetchDescriptionsFor(Controls c, String select, List<com.hp.hpl.jena.rdf.model.Resource> roots, com.hp.hpl.jena.rdf.model.Model m, APISpec spec, VarSupply vars, String graphName)
static View	getBuiltin(com.hp.hpl.jena.rdf.model.Resource r) Answer the built-in view with the given URI, or null if there isn't one.
String	getTemplate()
View.Type	getType()
boolean	isTemplateView()
long	minExpiryMillis(PropertyExpiryTimes pet, long givenDuration) minExpiryTime(pet, dur) returns the minimum of the expiry times for predicates in this view.
String	name()
String	nameWithoutCopy()
static View	newTemplateView(String viewName, String template)
void	setDescribeLabel(String labelPropertyURI) Set the describe label used by this viewer.
void	setDescribeThreshold(int threshold)
String	toString() Answer a string describing this view.
String	viewByTemplate(List<com.hp.hpl.jena.rdf.model.Resource> roots, com.hp.hpl.jena.rdf.model.Model m, APISpec spec, List<Source> sources, String graphName)

Methods inherited from class java.lang.Object

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

Field Detail

chains

protected final List<PropertyChain> chains

SHOW_ALL

public static final String SHOW_ALL

See Also:

Constant Field Values

SHOW_BASIC

public static final String SHOW_BASIC

See Also:

Constant Field Values

SHOW_DESCRIPTION

public static final String SHOW_DESCRIPTION

See Also:

Constant Field Values

SHOW_DEFAULT_INTERNAL

public static final String SHOW_DEFAULT_INTERNAL

See Also:

Constant Field Values

emptyChain

protected static final List<PropertyChain> emptyChain

ALL

public static final View ALL

View that does DESCRIBE plus labels of all objects.

BASIC

public static final View BASIC

View that does rdf:type and rdfs:label.

DESCRIBE

public static final View DESCRIBE

View that does DESCRIBE.

type

protected View.Type type

name

protected String name

template

protected String template

labelPropertyURI

protected String labelPropertyURI

describeThreshold

protected int describeThreshold

Constructor Detail

View

public View()

View

public View(String name)

View

public View(String name,
    View.Type type)

View

public View(String name,
    View.Type type,
    List<PropertyChain> initial)

Method Detail

getBuiltin

public static View getBuiltin(com.hp.hpl.jena.rdf.model.Resource r)

Answer the built-in view with the given URI, or null if there isn't one.

newTemplateView

public static View newTemplateView(String viewName,
                   String template)

equals

public boolean equals(Object other)

Overrides:

equals in class Object

name

public String name()

nameWithoutCopy

public String nameWithoutCopy()

getType

public View.Type getType()

chains

public Set<PropertyChain> chains()

copy

public View copy()

Answer this view if it is ALL, otherwise a new view that does the same filtering and is mutable without affecting the original.

isTemplateView

public boolean isTemplateView()

getTemplate

public String getTemplate()

setDescribeLabel

public void setDescribeLabel(String labelPropertyURI)

Set the describe label used by this viewer. The viewer type becomes ALL.

setDescribeThreshold

public void setDescribeThreshold(int threshold)

addViewFromRDFList

public View addViewFromRDFList(com.hp.hpl.jena.rdf.model.Resource spec,
                      ShortnameService sns)

Answer this view after modifying it to contain all the property chains defined by spec.

addViewFromParameterValue

public View addViewFromParameterValue(String prop,
                             ShortnameService sns)

Answer this view after updating it with the given property string. The property name may be dotted; it defines a property chain.

addFrom

public View addFrom(View t)

Answer this view after updating it by adding all the property chains of the argument view (which must not be null).

toString

public String toString()

Answer a string describing this view. It will show the list of property chains, possibly in an abbreviated form.

Overrides:

toString in class Object

fetchDescriptions

public String fetchDescriptions(Controls c,
                       View.State s)

createDescribeQueryForItems

public static String createDescribeQueryForItems(View.State s,
                                 List<com.hp.hpl.jena.rdf.model.Resource> allRoots)

fetchDescriptionsFor

public String fetchDescriptionsFor(Controls c,
                          String select,
                          List<com.hp.hpl.jena.rdf.model.Resource> roots,
                          com.hp.hpl.jena.rdf.model.Model m,
                          APISpec spec,
                          VarSupply vars,
                          String graphName)

viewByTemplate

public String viewByTemplate(List<com.hp.hpl.jena.rdf.model.Resource> roots,
                    com.hp.hpl.jena.rdf.model.Model m,
                    APISpec spec,
                    List<Source> sources,
                    String graphName)

minExpiryMillis

public long minExpiryMillis(PropertyExpiryTimes pet,
                   long givenDuration)

minExpiryTime(pet, dur) returns the minimum of the expiry times for predicates in this view. A predicate of propertySTAR, representing *, forces the result to use the smallest expiry time of any predicate. The result is the smaller of the givenDuration and the minimum expiry time.