Dataset Class Reference

A dataset block in the server's configuration. More...

Inheritance diagram for Dataset:

Collaboration diagram for Dataset:

Public Member Functions
	Dataset (Resource dataset, Configuration configuration)
DataSource	getDataSource ()
MetadataConfiguration	getMetadataConfiguration ()
boolean	supportsIRIs ()
boolean	addSameAsStatements ()
boolean	supportsSPARQL11 ()
Set< String >	getBrowsableNamespaces ()
	Gets all values of conf:browsableNamespace declared on the dataset resource. More...
Resource	getSelf ()
Model	getModel ()
boolean	hasType (Resource class_)
boolean	hasProperty (Property p)
Resource	getResource (Property p)
Set< Resource >	getResources (Property p)
Set< Property >	getProperties (Property p)
String	getIRI (Property p)
String	getIRI (Property p, String defaultValue)
String	getRequiredIRI (Property p)
Set< String >	getIRIs (Property p)
String	getString (Property p)
String	getString (Property p, String defaultValue)
Set< String >	getStrings (Property p)
boolean	getBoolean (Property p, boolean defaultValue)
void	requireExactlyOneOf (Property... properties)

Public Attributes
String	datasetBase
String	sparqlEndpoint

Private Member Functions
DataSource	buildDataSource (Configuration configuration)
void	assertHasOneValue (Property p)
void	assertResourceValue (Property p)
void	assertResourceValue (Statement stmt)
void	assertIRIValue (Property p)
void	assertIRIValue (Statement stmt)
void	assertLiteralValue (Property p)
void	assertLiteralValue (Statement stmt)
void	assertString (Statement stmt)
String	pretty (RDFNode node)
String	pretty (Statement stmt)
void	raiseMissingProperty (Property p)
void	raiseUnexpectedDatatype (String expectedDatatype, Statement stmt)

Private Attributes
final DataSource	dataSource
final MetadataConfiguration	metadata
RemoteSPARQLDataSource	sparqlDataSource = null
final Resource	resource

Detailed Description

A dataset block in the server's configuration.

Constructor & Destructor Documentation

Dataset()

Dataset	(	Resource	dataset,
		Configuration	configuration
	)

                                                                      {
                super(dataset);
                dataSource = buildDataSource(configuration);
                metadata = new MetadataConfiguration(dataset, sparqlDataSource);
        }

References Dataset.buildDataSource(), Dataset.dataSource, Dataset.metadata, and Dataset.sparqlDataSource.

Member Function Documentation

addSameAsStatements()

boolean addSameAsStatements

(

)

                                             {
                return getBoolean(CONF.addSameAsStatements, false);
        }

References CONF.addSameAsStatements, and ResourceReader.getBoolean().

Referenced by Dataset.buildDataSource().

assertHasOneValue()

void assertHasOneValue ( Property  p )

privateinherited

                                                   {
                StmtIterator it = resource.listProperties(p);
                if (!it.hasNext()) {
                        throw new ConfigurationException("Missing property " + pretty(p) + 
                                        " on resource " + pretty(resource));
                }
                it.next();
                if (it.hasNext()) {
                        throw new ConfigurationException("Too many values for property " +
                                        pretty(p) + " on resource " + pretty(resource));
                }
        }

References ResourceReader.pretty(), and ResourceReader.resource.

Referenced by ResourceReader.getBoolean(), ResourceReader.getIRI(), ResourceReader.getResource(), and ResourceReader.getString().

assertIRIValue() [1/2]

void assertIRIValue ( Property  p )

privateinherited

                                                {
                assertIRIValue(resource.getProperty(p));
        }

References ResourceReader.resource.

Referenced by ResourceReader.getIRI(), and ResourceReader.getIRIs().

assertIRIValue() [2/2]

void assertIRIValue ( Statement  stmt )

privateinherited

                                                    {
                if (stmt.getObject().isLiteral()) {
                        throw new ConfigurationException(
                                        "Expected IRI object, found literal: " + pretty(stmt));
                }
                if (stmt.getObject().isAnon()) {
                        throw new ConfigurationException(
                                        "Expected IRI object, found blank node: " + pretty(stmt));
                }
        }

References ResourceReader.pretty().

assertLiteralValue() [1/2]

void assertLiteralValue ( Property  p )

privateinherited

                                                    {
                assertLiteralValue(resource.getProperty(p));
        }

References ResourceReader.resource.

Referenced by ResourceReader.assertString(), and ResourceReader.getBoolean().

assertLiteralValue() [2/2]

void assertLiteralValue ( Statement  stmt )

privateinherited

                                                        {
                if (stmt.getObject().isURIResource()) {
                        throw new ConfigurationException(
                                        "Expected literal object, found IRI: " + pretty(stmt));
                }
                if (stmt.getObject().isAnon()) {
                        throw new ConfigurationException(
                                        "Expected literal object, found blank node: " + pretty(stmt));
                }
        }

References ResourceReader.pretty().

assertResourceValue() [1/2]

void assertResourceValue ( Property  p )

privateinherited

                                                     {
                assertResourceValue(resource.getProperty(p));
        }

References ResourceReader.resource.

Referenced by ResourceReader.getResource(), and ResourceReader.getResources().

assertResourceValue() [2/2]

void assertResourceValue ( Statement  stmt )

privateinherited

                                                         {
                if (stmt.getObject().isLiteral()) {
                        throw new ConfigurationException(
                                        "Expected resource object, found literal: " + pretty(stmt));
                }
        }

References ResourceReader.pretty().

assertString()

void assertString ( Statement  stmt )

privateinherited

                                                  {
                assertLiteralValue(stmt);
                Literal value = stmt.getLiteral();
                if (value.getDatatypeURI() == null || 
                                XSD.xstring.getURI().equals(value.getDatatypeURI()) ||
                                (RDF.getURI() + "langString").equals(value.getDatatypeURI())) {
                        return;
                }
                raiseUnexpectedDatatype("string", stmt);
        }

References ResourceReader.assertLiteralValue(), and ResourceReader.raiseUnexpectedDatatype().

Referenced by ResourceReader.getString(), and ResourceReader.getStrings().

buildDataSource()

DataSource buildDataSource ( Configuration  configuration )

private

                                                                        {
                requireExactlyOneOf(CONF.sparqlEndpoint, CONF.loadRDF);
 
                DataSource result;
                if (hasProperty(CONF.sparqlEndpoint)) {
                        
                        // SPARQL data source
                        String endpointURL = getIRI(CONF.sparqlEndpoint);
                        this.sparqlEndpoint=endpointURL;
                        String defaultGraphURI = getIRI(CONF.sparqlDefaultGraph);
                        sparqlDataSource = new RemoteSPARQLDataSource(
                                        endpointURL,
                                        defaultGraphURI,
                                        supportsSPARQL11(),
                                        getStrings(CONF.resourceDescriptionQuery),
                                        getStrings(CONF.propertyListQuery),
                                        getStrings(CONF.inversePropertyListQuery),
                                        getStrings(CONF.anonymousPropertyDescriptionQuery),
                                        getStrings(CONF.anonymousInversePropertyDescriptionQuery),
                                        configuration.getVocabularyStore().getHighIndegreeProperties(),
                                        configuration.getVocabularyStore().getHighOutdegreeProperties());
                        if (hasProperty(CONF.contentType)) {
                                sparqlDataSource.setGraphContentType(getString(CONF.contentType));
                        }
                        for (String param: getStrings(CONF.queryParamSelect)) {
                                sparqlDataSource.addSelectQueryParam(param);
                        }
                        for (String param: getStrings(CONF.queryParamGraph)) {
                                sparqlDataSource.addGraphQueryParam(param);
                        }
                        result = sparqlDataSource;
                        
                } else {
                        
                        // File data source
                        Model data = ModelFactory.createDefaultModel();
                        for (String fileName: getIRIs(CONF.loadRDF)) {
                                // If the location is a local file, then use webBase as base URI
                                // to resolve relative URIs in the file. Having file:/// URIs in
                                // there would likely not be useful to anyone.
                                //IRIResolver res=new IRIResolver();
                                //res.iriFactory().
                                //fileName = IRIResolver..resolveFileURL(fileName);
                                String base = (fileName.startsWith("file:/") ? 
                                                configuration.getWebApplicationBaseURI() : fileName);
 
                                try {
                                        Model m = RDFDataMgr.loadModel(fileName);
                                        data.add(m);
                                
                                        // We'd like to do simply data.setNsPrefix(m), but that leaves relative
                                        // namespace URIs like <#> unresolved, so we do a big dance to make them
                                        // absolute.
                                        for (String prefix: m.getNsPrefixMap().keySet()) {
                                                String uri=m.getNsPrefixMap().get("prefix");
                                                if(uri.contains("file:/")) {
                                                        data.setNsPrefix(prefix, uri.toString().replace("file:/", base));       
                                                }
                                        }
                                } catch (JenaException ex) {
                                        throw new ConfigurationException("Error reading <" + fileName + ">: " + ex.getMessage());
                                }
                        }
                        result = new ModelDataSource(data);
                }
 
                // If conf:datasetURIPattern is set, then filter the dataset accordingly.
                if (hasProperty(CONF.datasetURIPattern)) {
                        final Pattern pattern = Pattern.compile(getString(CONF.datasetURIPattern));
                        final DataSource fresult=result;
                        result = new FilteredDataSource(fresult) {
                                @Override
                                public boolean canDescribe(String absoluteIRI) {
                                        return pattern.matcher(absoluteIRI).find();
                                }
 
                                @Override
                                public Model describeResource(String absoluteIRI, String language) {
                                        // TODO Auto-generated method stub
                                        return null;
                                }
                        };
                }
                
                IRIRewriter rewriter = IRIRewriter.identity;
                
                // If conf:datasetBase is set (and different from conf:webBase),
                // rewrite the IRIs accordingly
                // Base IRI for IRIs considered to be "in" the data source
                String fullWebBase = configuration.getWebApplicationBaseURI() + 
                                configuration.getWebResourcePrefix();
                datasetBase = getIRI(CONF.datasetBase, 
                                fullWebBase);
                if (!datasetBase.equals(fullWebBase)) {
                        rewriter = IRIRewriter.createNamespaceBased(datasetBase, fullWebBase);
                }
 
                // Escape special characters in IRIs
                rewriter = IRIRewriter.chain(rewriter, new PubbyIRIEscaper(
                                fullWebBase, !supportsIRIs()));
 
                result = new RewrittenDataSource(
                                result, rewriter, addSameAsStatements());
 
                // Determine all browsable namespaces for this dataset
                final Set<String> browsableNamespaces = new HashSet<String>();
                browsableNamespaces.add(fullWebBase);
                for (String iri: getBrowsableNamespaces()) {
                        browsableNamespaces.add(iri);
                }
                browsableNamespaces.addAll(configuration.getBrowsableNamespaces());
 
                // Filter the dataset to keep only those resources in the datasetBase
                // and in browsable namespaces, unless it's an annotation provider
                if (!hasType(CONF.AnnotationProvider)) {
                        final DataSource fresult=result;
                        result = new FilteredDataSource(fresult) {
                                @Override
                                public boolean canDescribe(String absoluteIRI) {
                                        for (String namespace: browsableNamespaces) {
                                                if (absoluteIRI.startsWith(namespace)) return true;
                                        }
                                        return false;
                                }
 
                                @Override
                                public Model describeResource(String absoluteIRI, String language) {
                                        // TODO Auto-generated method stub
                                        return null;
                                }
                        };
                }
                
                return result;
        }

References RemoteSPARQLDataSource.addGraphQueryParam(), Dataset.addSameAsStatements(), RemoteSPARQLDataSource.addSelectQueryParam(), CONF.AnnotationProvider, CONF.anonymousInversePropertyDescriptionQuery, CONF.anonymousPropertyDescriptionQuery, IRIRewriter.chain(), CONF.contentType, IRIRewriter.createNamespaceBased(), Dataset.datasetBase, CONF.datasetBase, CONF.datasetURIPattern, Configuration.getBrowsableNamespaces(), Dataset.getBrowsableNamespaces(), VocabularyStore.getHighIndegreeProperties(), VocabularyStore.getHighOutdegreeProperties(), ResourceReader.getIRI(), ResourceReader.getIRIs(), ResourceReader.getString(), ResourceReader.getStrings(), Configuration.getVocabularyStore(), Configuration.getWebApplicationBaseURI(), Configuration.getWebResourcePrefix(), ResourceReader.hasProperty(), ResourceReader.hasType(), IRIRewriter.identity, CONF.inversePropertyListQuery, CONF.loadRDF, CONF.propertyListQuery, CONF.queryParamGraph, CONF.queryParamSelect, ResourceReader.requireExactlyOneOf(), CONF.resourceDescriptionQuery, RemoteSPARQLDataSource.setGraphContentType(), Dataset.sparqlDataSource, CONF.sparqlDefaultGraph, CONF.sparqlEndpoint, Dataset.supportsIRIs(), and Dataset.supportsSPARQL11().

Referenced by Dataset.Dataset().

getBoolean()

boolean getBoolean ( Property  p, boolean  defaultValue  )

inherited

                                                                    {
                if (!resource.hasProperty(p)) {
                        return defaultValue;
                }
                assertHasOneValue(p);
                assertLiteralValue(p);
                Literal value = resource.getProperty(p).getLiteral();
                if (XSD.xboolean.getURI().equals(value.getDatatypeURI())) {
                        return value.getBoolean();
                }
                if (value.getDatatypeURI() == null || XSD.xstring.getURI().equals(value.getDatatypeURI())) {
                        if ("true".equals(value.getString().toLowerCase())
                                        || "false".equals(value.getString().toLowerCase())) {
                                return "true".equals(value.getString().toLowerCase());
                        }
                }
                raiseUnexpectedDatatype("xsd:boolean", resource.getProperty(p));
                return false;
        }

References ResourceReader.assertHasOneValue(), ResourceReader.assertLiteralValue(), ResourceReader.raiseUnexpectedDatatype(), and ResourceReader.resource.

Referenced by Dataset.addSameAsStatements(), Configuration.showLabels(), Dataset.supportsIRIs(), and Dataset.supportsSPARQL11().

getBrowsableNamespaces()

Set<String> getBrowsableNamespaces

(

)

Gets all values of conf:browsableNamespace declared on the dataset resource.

Does not include values inherited from the configuration resource.

Returns

Namespace IRIs of browsable namespaces

                                                    {
                return getIRIs(CONF.browsableNamespace);
        }

References CONF.browsableNamespace, and ResourceReader.getIRIs().

Referenced by Dataset.buildDataSource(), and Configuration.Configuration().

getDataSource()

DataSource getDataSource

(

)

                                          {
                return dataSource;
        }

References Dataset.dataSource.

getIRI() [1/2]

String getIRI ( Property  p )

inherited

                                         {
                return getIRI(p, null);
        }

Referenced by Dataset.buildDataSource(), Configuration.Configuration(), Configuration.getProjectLink(), ResourceReader.getRequiredIRI(), and MetadataConfiguration.MetadataConfiguration().

getIRI() [2/2]

String getIRI ( Property  p, String  defaultValue  )

inherited

                                                              {
                if (!resource.hasProperty(p)) return defaultValue;
                assertHasOneValue(p);
                assertIRIValue(p);
                return resource.getProperty(p).getResource().getURI();          
        }

References ResourceReader.assertHasOneValue(), ResourceReader.assertIRIValue(), and ResourceReader.resource.

getIRIs()

Set<String> getIRIs ( Property  p )

inherited

                                               {
                Set<String> result = new HashSet<String>();
                StmtIterator it = resource.listProperties(p);
                while (it.hasNext()) {
                        Statement stmt = it.next();
                        assertIRIValue(stmt);
                        result.add(stmt.getResource().getURI());
                }
                return result;
        }

References ResourceReader.assertIRIValue(), and ResourceReader.resource.

Referenced by Dataset.buildDataSource(), Configuration.Configuration(), Configuration.getBrowsableNamespaces(), and Dataset.getBrowsableNamespaces().

getMetadataConfiguration()

MetadataConfiguration getMetadataConfiguration

(

)

                                                                {
                return metadata;
        }

References Dataset.metadata.

getModel()

Model getModel ( )

inherited

                                {
                return resource.getModel();
        }

References ResourceReader.resource.

Referenced by MetadataConfiguration.addMetadataFromTemplate(), Configuration.Configuration(), MetadataConfiguration.parsePlaceholder(), and ResourceReader.pretty().

getProperties()

Set<Property> getProperties ( Property  p )

inherited

                                                       {
                Set<Property> result = new HashSet<Property>();
                for (Resource r: getResources(p)) {
                        result.add(r.as(Property.class));
                }
                return result;
        }

References ResourceReader.getResources().

Referenced by Configuration.Configuration().

getRequiredIRI()

String getRequiredIRI ( Property  p )

inherited

                                                 {
                if (!resource.hasProperty(p)) {
                        raiseMissingProperty(p);
                }
                return getIRI(p);
        }

References ResourceReader.getIRI(), ResourceReader.raiseMissingProperty(), and ResourceReader.resource.

Referenced by Configuration.Configuration().

getResource()

Resource getResource ( Property  p )

inherited

                                                {
                if (!resource.hasProperty(p)) return null;
                assertHasOneValue(p);
                assertResourceValue(p);
                return resource.getProperty(p).getResource();           
        }

References ResourceReader.assertHasOneValue(), ResourceReader.assertResourceValue(), and ResourceReader.resource.

Referenced by MetadataConfiguration.MetadataConfiguration().

getResources()

Set<Resource> getResources ( Property  p )

inherited

                                                      {
                Set<Resource> result = new HashSet<Resource>();
                StmtIterator it = resource.listProperties(p);
                while (it.hasNext()) {
                        Statement stmt = it.next();
                        assertResourceValue(stmt);
                        result.add(stmt.getResource());
                }
                return result;
        }

References ResourceReader.assertResourceValue(), and ResourceReader.resource.

Referenced by Configuration.Configuration(), and ResourceReader.getProperties().

getSelf()

Resource getSelf ( )

inherited

                                  {
                return resource;
        }

References ResourceReader.resource.

Referenced by MetadataConfiguration.parsePlaceholder().

getString() [1/2]

String getString ( Property  p )

inherited

                                            {
                return getString(p, null);
        }

Referenced by Dataset.buildDataSource(), Configuration.getDefaultLanguage(), Configuration.getProjectName(), and Configuration.getWebResourcePrefix().

getString() [2/2]

String getString ( Property  p, String  defaultValue  )

inherited

                                                                 {
                if (!resource.hasProperty(p)) {
                        return defaultValue;
                }
                assertHasOneValue(p);
                assertString(resource.getProperty(p));
                return resource.getProperty(p).getString();
        }

References ResourceReader.assertHasOneValue(), ResourceReader.assertString(), and ResourceReader.resource.

getStrings()

Set<String> getStrings ( Property  p )

inherited

                                                  {
                Set<String> result = new HashSet<String>();
                StmtIterator it = resource.listProperties(p);
                while (it.hasNext()) {
                        Statement stmt = it.next();
                        assertString(stmt);
                        result.add(stmt.getString());
                }
                return result;
        }

References ResourceReader.assertString(), and ResourceReader.resource.

Referenced by Dataset.buildDataSource().

hasProperty()

boolean hasProperty ( Property  p )

inherited

                                               {
                return resource.hasProperty(p);
        }

References ResourceReader.resource.

Referenced by Configuration.buildDataSource(), Dataset.buildDataSource(), and Configuration.Configuration().

hasType()

boolean hasType ( Resource  class_ )

inherited

                                                {
                return resource.hasProperty(RDF.type, class_);
        }

References ResourceReader.resource.

Referenced by Dataset.buildDataSource().

pretty() [1/2]

String pretty ( RDFNode  node )

privateinherited

                                            {
                if (node.isAnon()) return "[]";
                if (node.isURIResource()) {
                        Resource r = node.asResource();
                        if (getModel().qnameFor(r.getURI()) == null) {
                                return "<" + r.getURI() + ">";
                        }
                        return getModel().qnameFor(r.getURI());
                }
                return PrintUtil.print(node);
        }

References ResourceReader.getModel().

Referenced by ResourceReader.assertHasOneValue(), ResourceReader.assertIRIValue(), ResourceReader.assertLiteralValue(), ResourceReader.assertResourceValue(), ResourceReader.pretty(), ResourceReader.raiseMissingProperty(), ResourceReader.raiseUnexpectedDatatype(), and ResourceReader.requireExactlyOneOf().

pretty() [2/2]

String pretty ( Statement  stmt )

privateinherited

                                              {
                return pretty(stmt.getSubject()) + " " + pretty(stmt.getPredicate())
                                + " " + pretty(stmt.getObject()) + ".";
        }

References ResourceReader.pretty().

raiseMissingProperty()

void raiseMissingProperty ( Property  p )

privateinherited

                                                      {
                throw new ConfigurationException("Missing property " + 
                                pretty(p) + " on resource " + pretty(resource));
        }

References ResourceReader.pretty(), and ResourceReader.resource.

Referenced by ResourceReader.getRequiredIRI().

raiseUnexpectedDatatype()

void raiseUnexpectedDatatype ( String  expectedDatatype, Statement  stmt  )

privateinherited

                                                                                      {
                throw new ConfigurationException(
                                "Expected " + expectedDatatype + 
                                " object, found other datatype: " + 
                                pretty(stmt));
        }

References ResourceReader.pretty().

Referenced by ResourceReader.assertString(), and ResourceReader.getBoolean().

requireExactlyOneOf()

void requireExactlyOneOf ( Property...  properties )

inherited

                                                                {
                Property found = null;
                boolean first = true;
                StringBuilder s = new StringBuilder();
                for (Property p: properties) {
                        if (resource.hasProperty(p)) {
                                if (found == null) {
                                        found = p;
                                } else {
                                        throw new ConfigurationException("Can't have both " +
                                                        pretty(found) + " and " + pretty(p) + 
                                                        " on resource " + pretty(resource));
                                }
                        }
                        if (!first) {
                                s.append(", ");
                        }
                        s.append(pretty(p));
                        first = false;
                }
                if (found == null) {
                        throw new ConfigurationException("One of " + s.toString() + 
                                        " required on resource " + pretty(resource));
                }
        }

References ResourceReader.pretty(), and ResourceReader.resource.

Referenced by Dataset.buildDataSource().

supportsIRIs()

boolean supportsIRIs

(

)

                                      {
                return getBoolean(CONF.supportsIRIs, true);
        }

References ResourceReader.getBoolean(), and CONF.supportsIRIs.

Referenced by Dataset.buildDataSource().

supportsSPARQL11()

boolean supportsSPARQL11

(

)

                                          {
                return getBoolean(CONF.supportsSPARQL11, false);
        }

References ResourceReader.getBoolean(), and CONF.supportsSPARQL11.

Referenced by Dataset.buildDataSource().

Member Data Documentation

datasetBase

String datasetBase

Referenced by Dataset.buildDataSource().

dataSource

final DataSource dataSource

private

Referenced by Dataset.Dataset(), and Dataset.getDataSource().

metadata

final MetadataConfiguration metadata

private

Referenced by Dataset.Dataset(), and Dataset.getMetadataConfiguration().

resource

final Resource resource

privateinherited

Referenced by ResourceReader.assertHasOneValue(), ResourceReader.assertIRIValue(), ResourceReader.assertLiteralValue(), ResourceReader.assertResourceValue(), ResourceReader.getBoolean(), ResourceReader.getIRI(), ResourceReader.getIRIs(), ResourceReader.getModel(), ResourceReader.getRequiredIRI(), ResourceReader.getResource(), ResourceReader.getResources(), ResourceReader.getSelf(), ResourceReader.getString(), ResourceReader.getStrings(), ResourceReader.hasProperty(), ResourceReader.hasType(), ResourceReader.raiseMissingProperty(), ResourceReader.requireExactlyOneOf(), and ResourceReader.ResourceReader().

sparqlDataSource

RemoteSPARQLDataSource sparqlDataSource = null

private

Referenced by Dataset.buildDataSource(), and Dataset.Dataset().

sparqlEndpoint

String sparqlEndpoint