Package com.janeirodigital.sai.core.agents

Class SocialAgentRegistration.Builder

java.lang.Object

com.janeirodigital.sai.core.resources.ReadableResource.Builder<T>

com.janeirodigital.sai.core.resources.CRUDResource.Builder<T>

com.janeirodigital.sai.core.agents.AgentRegistration.Builder<SocialAgentRegistration.Builder>

com.janeirodigital.sai.core.agents.SocialAgentRegistration.Builder

Enclosing class:

SocialAgentRegistration

public static class SocialAgentRegistration.Builder
extends AgentRegistration.Builder<SocialAgentRegistration.Builder>

Builder for SocialAgentRegistration instances.

Field Summary

Fields inherited from class com.janeirodigital.sai.core.agents.AgentRegistration.Builder

accessGrantUri, registeredAgent, registeredAt, registeredBy, registeredWith, updatedAt

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

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

Constructor Summary

Constructors

Constructor	Description
Builder(URI uri, SaiSession saiSession)	Initialize builder with uri and saiSession

Method Summary

Modifier and Type	Method	Description
SocialAgentRegistration	build()	Build the SocialAgentRegistration using attributes from the Builder.
SocialAgentRegistration.Builder	getThis()	Ensures that we don't get an unchecked cast warning when returning from setters
protected void	populateDataset()	Populates the Jena dataset graph with the attributes from the Builder
protected void	populateFromDataset()	Populates the fields of the SocialAgentRegistration.Builder based on the associated Jena resource.
SocialAgentRegistration.Builder	setDataset(org.apache.jena.rdf.model.Model dataset)	Set the Jena model and use it to populate attributes of the SocialAgentRegistration.Builder.
SocialAgentRegistration.Builder	setReciprocalRegistration(URI registrationUri)	Set the Reciprocal Registration that registeredAgent maintains for the social agent that owns the agent registry.

Methods inherited from class com.janeirodigital.sai.core.agents.AgentRegistration.Builder

setAccessGrant, setRegisteredAgent, setRegisteredAt, setRegisteredBy, setRegisteredWith, setUpdatedAt

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

setContentType, setDataset, setJsonLdContext, setUnprotected

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder(URI uri,
 SaiSession saiSession)

Initialize builder with uri and saiSession

Parameters:

uri - URI of the SocialAgentRegistration to build

saiSession - SaiSession to assign

Method Details

getThis

public SocialAgentRegistration.Builder getThis()

Ensures that we don't get an unchecked cast warning when returning from setters

Specified by:

getThis in class ReadableResource.Builder<SocialAgentRegistration.Builder>

Returns:

SocialAgentRegistration.Builder

setDataset

public SocialAgentRegistration.Builder setDataset(org.apache.jena.rdf.model.Model dataset)
                                           throws SaiException

Set the Jena model and use it to populate attributes of the SocialAgentRegistration.Builder. Assumption is made that the corresponding resource exists.

Overrides:

setDataset in class ReadableResource.Builder<SocialAgentRegistration.Builder>

Parameters:

dataset - Jena model to populate the Builder attributes with

Returns:

SocialAgentRegistration.Builder

Throws:

SaiException

setReciprocalRegistration

public SocialAgentRegistration.Builder setReciprocalRegistration(URI registrationUri)

Set the Reciprocal Registration that registeredAgent maintains for the social agent that owns the agent registry.

Parameters:

registrationUri - URI of the reciprocal social agent registration

See Also:

• Agent Registry

populateFromDataset

protected void populateFromDataset()
                            throws SaiException

Populates the fields of the SocialAgentRegistration.Builder based on the associated Jena resource.

Overrides:

populateFromDataset in class AgentRegistration.Builder<SocialAgentRegistration.Builder>

Throws:

SaiException

populateDataset

protected void populateDataset()

Populates the Jena dataset graph with the attributes from the Builder

Overrides:

populateDataset in class AgentRegistration.Builder<SocialAgentRegistration.Builder>

build

public SocialAgentRegistration build()
                              throws SaiException

Build the SocialAgentRegistration using attributes from the Builder. If no Jena dataset has been provided, then the dataset will be populated using the attributes from the Builder with populateDataset().

Returns:

DataGrant

Throws:

SaiException