com.socrata.builders

Class AbstractDatasetInfoBuilder<BUILDER extends AbstractDatasetInfoBuilder,BUILDEE extends DatasetInfo>

java.lang.Object

com.socrata.builders.AbstractDatasetInfoBuilder<BUILDER,BUILDEE>

Direct Known Subclasses:

DatasetBuilder, DatasetInfoBuilder, ExternalDatasetBuilder, NonDataFileDatasetBuilder

public abstract class AbstractDatasetInfoBuilder<BUILDER extends AbstractDatasetInfoBuilder,BUILDEE extends DatasetInfo>
extends Object

A DatasetInfoBuilder that can be used by builders of all the sub-classes. Handles all the common properties.

Field Summary

Fields

Modifier and Type	Field and Description
protected String	attribution
protected String	attributionLink
protected String	category
protected List<Column>	columns
protected String	description
protected String	externalId
protected String	id
protected License	license
protected String	licenseId
protected Metadata	metadata
protected String	name
protected Map<String,Object>	privateMetadata
protected String	publicationStage
protected String	resourceName
protected List<String>	tags
protected String	viewType

Constructor Summary

Constructors

Constructor and Description
AbstractDatasetInfoBuilder()
AbstractDatasetInfoBuilder(DatasetInfo datasetInfo)

Method Summary

Methods

Modifier and Type	Method and Description
BUILDER	addTag(String tag)
abstract BUILDEE	build() The method that needs to be implemented by all the sub classes to actually be able to build the object being constructed.
void	populate(DatasetInfo retVal) Copies the common properties into the DatasetInfo that is passed in.
BUILDER	removeTag(String tag)
BUILDER	setAttribution(String attribution)
BUILDER	setAttributionLink(String attributionLink)
BUILDER	setCategory(String category)
BUILDER	setDescription(String description)
BUILDER	setExternalId(String externalId)
BUILDER	setId(String id)
BUILDER	setLicense(License license)
BUILDER	setLicenseId(String licenseId)
BUILDER	setMetadata(Metadata metadata)
BUILDER	setName(String name)
BUILDER	setPrivateMetadata(Map<String,Object> privateMetadata)
BUILDER	setPublicationStage(String publicationStage)
BUILDER	setResourceName(String resourceName)
BUILDER	setTags(List<String> tags)
BUILDER	setViewType(String viewType)

Methods inherited from class java.lang.Object

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

Field Detail

resourceName

protected String resourceName

viewType

protected String viewType

attribution

protected String attribution

attributionLink

protected String attributionLink

category

protected String category

description

protected String description

externalId

protected String externalId

id

protected String id

license

protected License license

licenseId

protected String licenseId

name

protected String name

metadata

protected Metadata metadata

privateMetadata

protected Map<String,Object> privateMetadata

publicationStage

protected String publicationStage

tags

protected List<String> tags

columns

protected List<Column> columns

Constructor Detail

AbstractDatasetInfoBuilder

public AbstractDatasetInfoBuilder()

AbstractDatasetInfoBuilder

public AbstractDatasetInfoBuilder(DatasetInfo datasetInfo)

Method Detail

setResourceName

public BUILDER setResourceName(String resourceName)

setViewType

public BUILDER setViewType(String viewType)

setAttribution

public BUILDER setAttribution(String attribution)

setAttributionLink

public BUILDER setAttributionLink(String attributionLink)

setCategory

public BUILDER setCategory(String category)

setDescription

public BUILDER setDescription(String description)

setExternalId

public BUILDER setExternalId(String externalId)

setId

public BUILDER setId(String id)

setLicense

public BUILDER setLicense(License license)

setLicenseId

public BUILDER setLicenseId(String licenseId)

setName

public BUILDER setName(String name)

setMetadata

public BUILDER setMetadata(Metadata metadata)

setPrivateMetadata

public BUILDER setPrivateMetadata(Map<String,Object> privateMetadata)

setPublicationStage

public BUILDER setPublicationStage(String publicationStage)

setTags

public BUILDER setTags(List<String> tags)

addTag

public BUILDER addTag(String tag)

removeTag

public BUILDER removeTag(String tag)

populate

public void populate(DatasetInfo retVal)

Copies the common properties into the DatasetInfo that is passed in. It is important to note that this has the side effect of modifying the argument in place.

Parameters:

retVal - The value to populate with properties.

build

public abstract BUILDEE build()

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

Returns:

The object built from the parameters in the builder.