com.socrata.builders

Class ExternalDatasetBuilder

java.lang.Object

com.socrata.builders.AbstractDatasetInfoBuilder<ExternalDatasetBuilder,ExternalDataset>

com.socrata.builders.ExternalDatasetBuilder

public class ExternalDatasetBuilder
extends AbstractDatasetInfoBuilder<ExternalDatasetBuilder,ExternalDataset>

Builds an external dataset that can be added to the server through the operations in SodaDDL for creating or updating a dataset. External dataset references are datasets that are not hosted by Socrata, but where Socrata provides a reference to another dataset.

Field Summary

Fields inherited from class com.socrata.builders.AbstractDatasetInfoBuilder

attribution, attributionLink, category, columns, description, externalId, id, license, licenseId, metadata, name, privateMetadata, publicationStage, resourceName, tags, viewType

Constructor Summary

Constructors

Constructor and Description
ExternalDatasetBuilder()
ExternalDatasetBuilder(ExternalDataset datasetInfo)

Method Summary

Methods

Modifier and Type	Method and Description
ExternalDatasetBuilder	addAccessPoint(String type, String url) Adds a single access point for an external dataset.
ExternalDataset	build() The method that needs to be implemented by all the sub classes to actually be able to build the object being constructed.
ExternalDatasetBuilder	setAccessPoints(Map<String,String> accessPoints) Sets all the access points for an external dataset.

Methods inherited from class com.socrata.builders.AbstractDatasetInfoBuilder

addTag, populate, removeTag, setAttribution, setAttributionLink, setCategory, setDescription, setExternalId, setId, setLicense, setLicenseId, setMetadata, setName, setPrivateMetadata, setPublicationStage, setResourceName, setTags, setViewType

Methods inherited from class java.lang.Object

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

Constructor Detail

ExternalDatasetBuilder

public ExternalDatasetBuilder()

ExternalDatasetBuilder

public ExternalDatasetBuilder(ExternalDataset datasetInfo)

Method Detail

setAccessPoints

public ExternalDatasetBuilder setAccessPoints(Map<String,String> accessPoints)

Sets all the access points for an external dataset. This MUST be called after the metadata object is alread set on the object.

Parameters:

accessPoints - the access points to the external dataset.

Returns:

addAccessPoint

public ExternalDatasetBuilder addAccessPoint(String type,
                                    String url)

Adds a single access point for an external dataset. This MUST be called after the metadata object is alread set on the object.

Parameters:

type - the object type

url - the URLto the object

Returns:

build

public ExternalDataset build()

Description copied from class: AbstractDatasetInfoBuilder

The method that needs to be implemented by all the sub classes to actually be able to build the object being constructed.

Specified by:

build in class AbstractDatasetInfoBuilder<ExternalDatasetBuilder,ExternalDataset>

Returns:

The object built from the parameters in the builder.