Package com.janeirodigital.sai.core.data

Class DataInstance

java.lang.Object

com.janeirodigital.sai.core.resources.ReadableResource

com.janeirodigital.sai.core.resources.CRUDResource

com.janeirodigital.sai.core.data.DataInstance

Direct Known Subclasses:

BasicDataInstance

public abstract class DataInstance
extends CRUDResource

General instantiation of a Data Instance. This class should either be extended (through inheritance) or included through composition in a class specific to a given data domain. For a specific instantiation, see BasicDataInstance.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DataInstance.Builder<T extends CRUDResource.Builder<T>>	Builder for DataInstance instances.

Field Summary

Fields inherited from class com.janeirodigital.sai.core.resources.ReadableResource

contentType, dataset, exists, httpClient, jsonLdContext, resource, saiSession, unprotected, uri

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	DataInstance(DataInstance.Builder<?> builder)

Method Summary

Modifier and Type	Method	Description
void	addChildInstance(DataInstance childInstance)	Add a child data instance by adding a shape tree reference relationship to the instance graph, as authorized by an inherited data grant.
void	delete()	Delete the corresponding DataInstance resource over HTTP .
ReadableDataGrant	findChildGrant(URI shapeTreeUri)
protected List<URI>	findChildReferences(com.janeirodigital.shapetrees.core.validation.ShapeTreeReference reference)	Searches the instance graph for instances of the provided shape tree reference and returns the associated targets (objects) they link to
static URI	generateUri(ReadableDataGrant dataGrant)	Generate the URI for a new DataInstance as permitted by the provided dataGrant, with a generated UUID as resource name.
static URI	generateUri(ReadableDataGrant dataGrant, String resourceName)	Generate the URI for a new DataInstance as permitted by the provided dataGrant.
DataInstanceList	getChildInstances(URI shapeTreeUri)	Gets a list of "child" data instances that are associated with the current instance via shape tree reference as part of an inherited data grant.
List<URI>	getChildReferences(URI shapeTreeUri)	Gets a list of references to "child" data instances based on a shape tree reference in the shape tree identified by the provided shapeTreeUri.
boolean	hasAccessible(URI shapeTreeUri)
void	removeChildInstance(DataInstance childInstance)	Remove a child data instance by removing a shape tree reference relationship from the instance graph.
void	update()	Update the corresponding DataInstance resource over HTTP with the current contents of the dataset.

Methods inherited from class com.janeirodigital.sai.core.resources.ReadableResource

checkReadableResponse, read

Methods inherited from class java.lang.Object

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

Constructor Details

DataInstance

protected DataInstance(DataInstance.Builder<?> builder)
                throws SaiException

Throws:

SaiException

Method Details

update

public void update()
            throws SaiException

Update the corresponding DataInstance resource over HTTP with the current contents of the dataset. In the event that an inherited instance is being created, the parent instance is updated to add a reference to the created child instance.

Overrides:

update in class CRUDResource

Throws:

SaiException

delete

public void delete()
            throws SaiException

Delete the corresponding DataInstance resource over HTTP . In the event that an inherited instance is being deleted, the parent instance is updated to remove the reference to the deleted child instance.

Overrides:

delete in class CRUDResource

Throws:

SaiException

getChildInstances

public DataInstanceList getChildInstances(URI shapeTreeUri)
                                   throws SaiException

Gets a list of "child" data instances that are associated with the current instance via shape tree reference as part of an inherited data grant.

Parameters:

shapeTreeUri - URI of the shape tree type to get children for

Returns:

List of data instances for the provided shape tree

Throws:

SaiException

addChildInstance

public void addChildInstance(DataInstance childInstance)
                      throws SaiException

Add a child data instance by adding a shape tree reference relationship to the instance graph, as authorized by an inherited data grant.

Parameters:

childInstance - Child DataInstance to add

Throws:

SaiException

removeChildInstance

public void removeChildInstance(DataInstance childInstance)
                         throws SaiException

Remove a child data instance by removing a shape tree reference relationship from the instance graph.

Parameters:

childInstance - Child DataInstance to remove

Throws:

SaiException

getChildReferences

public List<URI> getChildReferences(URI shapeTreeUri)
                             throws SaiException

Gets a list of references to "child" data instances based on a shape tree reference in the shape tree identified by the provided shapeTreeUri.

Parameters:

shapeTreeUri - URI of the shape tree type to get children for

Returns:

List of child data instance URIs

Throws:

SaiException

generateUri

public static URI generateUri(ReadableDataGrant dataGrant,
 String resourceName)
                       throws SaiException

Generate the URI for a new DataInstance as permitted by the provided dataGrant. UUID will be generated and used for resourceName if it is null.

Parameters:

dataGrant - ReadableDataGrant allowing the instance to be created

resourceName - Name of the instance to create

Returns:

URI for new instance

Throws:

SaiException

generateUri

public static URI generateUri(ReadableDataGrant dataGrant)
                       throws SaiException

Generate the URI for a new DataInstance as permitted by the provided dataGrant, with a generated UUID as resource name.

Parameters:

dataGrant - ReadableDataGrant allowing the instance to be created

Returns:

URI for new instance

Throws:

SaiException

findChildGrant

public ReadableDataGrant findChildGrant(URI shapeTreeUri)
                                 throws SaiException

Throws:

SaiException

hasAccessible

public boolean hasAccessible(URI shapeTreeUri)
                      throws SaiException

Throws:

SaiException

findChildReferences

protected List<URI> findChildReferences(com.janeirodigital.shapetrees.core.validation.ShapeTreeReference reference)
                                 throws SaiException

Searches the instance graph for instances of the provided shape tree reference and returns the associated targets (objects) they link to

Parameters:

reference - shape tree references search with

Returns:

List of referenced URIs

Throws:

SaiException