org.linkeddatafragments.fragments

Class LinkedDataFragmentBase

java.lang.Object

org.linkeddatafragments.fragments.LinkedDataFragmentBase

All Implemented Interfaces:

Closeable, AutoCloseable, ILinkedDataFragment

Direct Known Subclasses:

TriplePatternFragmentBase

public abstract class LinkedDataFragmentBase
extends Object
implements ILinkedDataFragment

Base class of any implementation of ILinkedDataFragment that uses paging.

Author:

Olaf Hartig

Field Summary

Fields

Modifier and Type	Field and Description
String	datasetURL
String	fragmentURL
boolean	isLastPage
long	pageNumber

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	LinkedDataFragmentBase(String fragmentURL, String datasetURL, long pageNumber, boolean isLastPage)

Method Summary

Modifier and Type	Method and Description
void	addControls(org.apache.jena.rdf.model.Model model) Adds an RDF description of page links to the given RDF model.
void	addMetadata(org.apache.jena.rdf.model.Model model) Adds some basic metadata to the given RDF model.
void	close() Does nothing.
org.apache.jena.rdf.model.StmtIterator	getControls() This implementation uses addControls(Model), which should be overridden in subclasses (instead of overriding this method).
String	getDatasetURI()
long	getMaxPageSize() Returns the maximum number of triples per page if ILinkedDataFragment.getTriples() returns a page of data only (that is, if ILinkedDataFragment.isPageOnly() returns true).
org.apache.jena.rdf.model.StmtIterator	getMetadata() This implementation uses addMetadata(Model), which should be overridden in subclasses (instead of overriding this method).
long	getPageNumber() Returns the number of the page of data returned by ILinkedDataFragment.getTriples() if the data is paged (that is, if ILinkedDataFragment.isPageOnly() returns true).
boolean	isLastPage() Returns true if ILinkedDataFragment.getTriples() returns a page of data only and this is the last page of the fragment.
boolean	isPageOnly() Returns true if ILinkedDataFragment.getTriples() returns a page of data only.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.linkeddatafragments.fragments.ILinkedDataFragment

getTriples

Field Detail

fragmentURL

public final String fragmentURL

datasetURL

public final String datasetURL

pageNumber

public final long pageNumber

isLastPage

public final boolean isLastPage

Constructor Detail

LinkedDataFragmentBase

protected LinkedDataFragmentBase(String fragmentURL,
                                 String datasetURL,
                                 long pageNumber,
                                 boolean isLastPage)

Parameters:

fragmentURL -

datasetURL -

pageNumber -

isLastPage -

Method Detail

close

public void close()

Does nothing. May be overridden by subclasses that hold some objects that need to be closed (such as iterators from the underlying data source).

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

isPageOnly

public boolean isPageOnly()

Description copied from interface: ILinkedDataFragment

Returns true if ILinkedDataFragment.getTriples() returns a page of data only. In this case, ILinkedDataFragment.getPageNumber() can be used to obtain the corresponding page number.

Specified by:

isPageOnly in interface ILinkedDataFragment

Returns:

getPageNumber

public long getPageNumber()

Description copied from interface: ILinkedDataFragment

Returns the number of the page of data returned by ILinkedDataFragment.getTriples() if the data is paged (that is, if ILinkedDataFragment.isPageOnly() returns true). If the data is not paged, this method throws an exception.

Specified by:

getPageNumber in interface ILinkedDataFragment

Returns:

isLastPage

public boolean isLastPage()

Description copied from interface: ILinkedDataFragment

Returns true if ILinkedDataFragment.getTriples() returns a page of data only and this is the last page of the fragment. If the data is not paged (i.e., if ILinkedDataFragment.isPageOnly() returns false), this method throws an exception.

Specified by:

isLastPage in interface ILinkedDataFragment

Returns:

getMaxPageSize

public long getMaxPageSize()

Description copied from interface: ILinkedDataFragment

Returns the maximum number of triples per page if ILinkedDataFragment.getTriples() returns a page of data only (that is, if ILinkedDataFragment.isPageOnly() returns true). If the data is not paged, this method throws an exception.

Specified by:

getMaxPageSize in interface ILinkedDataFragment

Returns:

getMetadata

public org.apache.jena.rdf.model.StmtIterator getMetadata()

This implementation uses addMetadata(Model), which should be overridden in subclasses (instead of overriding this method).

Specified by:

getMetadata in interface ILinkedDataFragment

Returns:

getControls

public org.apache.jena.rdf.model.StmtIterator getControls()

This implementation uses addControls(Model), which should be overridden in subclasses (instead of overriding this method).

Specified by:

getControls in interface ILinkedDataFragment

Returns:

addMetadata

public void addMetadata(org.apache.jena.rdf.model.Model model)

Adds some basic metadata to the given RDF model. This method may be overridden in subclasses.

Parameters:

model -

addControls

public void addControls(org.apache.jena.rdf.model.Model model)

Adds an RDF description of page links to the given RDF model. This method may be overridden in subclasses.

Parameters:

model -

getDatasetURI

public String getDatasetURI()

Returns: