com.socrata.model.importer

Class DatasetInfo

java.lang.Object

com.socrata.model.importer.DatasetInfo

Direct Known Subclasses:

Dataset, ExternalDataset, NonDataFileDataset

public class DatasetInfo
extends Object

Class that contains all the information about a dataset NOT related to its actual schema. An easy way to think of this class is all the parts of a dataset you can change without having to put it into a Working Copy.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DATASET_TYPE
static String	EXTERNAL_TYPE
static String	FILE_TYPE
static String	PUBLISHED
static String	UNPUBLISHED

Constructor Summary

Constructors

Constructor and Description
DatasetInfo()

Method Summary

Methods

Modifier and Type	Method and Description
static DatasetInfo	copy(DatasetInfo src) Does a deep copy of this DatasetInfo.
String	getAttribution() The Attribution for the current license.
String	getAttributionLink() A link to the attribution for this license.
String	getCategory() Gets the main category used to classify this dataset.
String	getDescription() Gets the human readable description of this dataset.
String	getExternalId() Sometimes datasets have an ID in a system outside Socrata.
List<Grant>	getGrants() Gets all the permission grants for this dataset.
String	getId() This unique ID for this dataset.
License	getLicense() Gets the license structure that defines this license.
String	getLicenseId() The unique ID for the license that applies to this dataset.
Metadata	getMetadata() Gets the metadata for this dataset
String	getName() Gets the human readable name for this dataset.
Map<String,Object>	getPrivateMetadata() Gets private metadata for this dataset.
String	getPublicationStage() Returns whether this dataset is in a published or unpublished state.
String	getResourceName() Gets the resource name for this dataset.
List<String>	getRights()
Long	getRowsUpdatedAt() A long representing the seconds since the epoch till this was modified.
List<String>	getTags() Gets the list of freeform tags describing this dataset.
String	getViewType() describes what type of object this is.
void	setAttribution(String attribution) The Attribution for the current license.
void	setAttributionLink(String attributionLink) A link to the attribution for this license.
void	setCategory(String category) Sets the main category used to classify this dataset.
void	setDescription(String description) Sets the human readable description of this dataset.
void	setExternalId(String externalId) Sometimes datasets have an ID in a system outside Socrata.
void	setGrants(List<Grant> grants) Sets all the permission grants for this dataset.
void	setId(String id) Sets the unique ID for this dataset.
void	setLicense(License license) Sets the license structure that defines this license.
void	setLicenseId(String licenseId) The unique ID for the license that applies to this dataset.
void	setMetadata(Metadata metadata) Sets the metadata for this dataset
void	setName(String name) Gets the human readable name for this dataset.
void	setPrivateMetadata(Map<String,Object> privateMetadata) Sets private metadata for this dataset.
void	setPublicationStage(String publicationStage) This should really only be called by the system.
void	setResourceName(String resourceName) Sets the resource name for this dataset.
void	setRights(List<String> rights)
void	setRowsUpdatedAt(Long rowsUpdatedAt) This method should only be called by the system, since the system is responsible for setting the modified date.
void	setTags(List<String> tags) Gets the list of freeform tags describing this dataset.
void	setupLicense(LicenseInfo licenseInfo, String attribution, String attributionLink) Sets up the license portion of the dataset info from a LicenseInfo and an attribution.
void	setViewType(String viewType) Sets what type of object this is.

Methods inherited from class java.lang.Object

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

Field Detail

DATASET_TYPE

public static final String DATASET_TYPE

See Also:

Constant Field Values

FILE_TYPE

public static final String FILE_TYPE

See Also:

Constant Field Values

EXTERNAL_TYPE

public static final String EXTERNAL_TYPE

See Also:

Constant Field Values

PUBLISHED

public static final String PUBLISHED

See Also:

Constant Field Values

UNPUBLISHED

public static final String UNPUBLISHED

See Also:

Constant Field Values

Constructor Detail

DatasetInfo

public DatasetInfo()

Method Detail

copy

public static DatasetInfo copy(DatasetInfo src)

Does a deep copy of this DatasetInfo.

Parameters:

src -

Returns:

getResourceName

public String getResourceName()

Gets the resource name for this dataset. The Resource Name is a name that can be used on the URL to access the dataset. E.g. if a dataset had a resource name of my_dataset, it would be accessible via: https://mysite.socrata.com/id/my_dataset

Returns:

the resource name

setResourceName

public void setResourceName(String resourceName)

Sets the resource name for this dataset. The Resource Name is a name that can be used on the URL to access the dataset. E.g. if a dataset had a resource name of my_dataset, it would be accessible via: https://mysite.socrata.com/id/my_dataset

getViewType

public String getViewType()

describes what type of object this is. The possible values are:

• tabular
• blobby
• href

Returns:

the object type

setViewType

public void setViewType(String viewType)

Sets what type of object this is. This should not be changed for existing objects.

Parameters:

viewType - the object type

getAttribution

public String getAttribution()

The Attribution for the current license. Not all licenses require attribution. Look at the LicenseInfo enum to find some of the licenses that do or don't need attribution.

Returns:

the attribution for this license.

setAttribution

public void setAttribution(String attribution)

The Attribution for the current license. Not all licenses require attribution. Look at the LicenseInfo enum to find some of the licenses that do or don't need attribution.

Parameters:

attribution - the attribution for this license.

getAttributionLink

public String getAttributionLink()

A link to the attribution for this license. Not all licenses require attribution. Look at the LicenseInfo enum to find some of the licenses that do or don't need attribution.

Returns:

the link to the attribution for this license.

setAttributionLink

public void setAttributionLink(String attributionLink)

A link to the attribution for this license. Not all licenses require attribution. Look at the LicenseInfo enum to find some of the licenses that do or don't need attribution.

Parameters:

attributionLink - the link to the attribution for this license.

getCategory

public String getCategory()

Gets the main category used to classify this dataset.

Returns:

main category used to classify this dataset.

setCategory

public void setCategory(String category)

Sets the main category used to classify this dataset.

Parameters:

category - main category used to classify this dataset.

getDescription

public String getDescription()

Gets the human readable description of this dataset.

Returns:

human readable description for this dataset.

setDescription

public void setDescription(String description)

Sets the human readable description of this dataset.

Parameters:

description - human readable description for this dataset.

getExternalId

public String getExternalId()

Sometimes datasets have an ID in a system outside Socrata. This field is where you can store this info. Although this is opaque to the system, common values here are URLs, URIs, GUIDs or other globally unique constructs.

Returns:

the external ID

setExternalId

public void setExternalId(String externalId)

Sometimes datasets have an ID in a system outside Socrata. This field is where you can store this info. Although this is opaque to the system, common values here are URLs, URIs, GUIDs or other globally unique constructs.

Parameters:

externalId - the external ID

getId

public String getId()

This unique ID for this dataset. The format of this key will be the 4x4 format used by socrata, e.g. abcd-efgh This key cannot be changed after the dataset is created.

Returns:

the unique Id of the dataset, or null if this is not persisted yet.

setId

public void setId(String id)

Sets the unique ID for this dataset. This should only really be set by the system.

Parameters:

id - the unique Id of the dataset

setupLicense

public void setupLicense(LicenseInfo licenseInfo,
                String attribution,
                String attributionLink)

Sets up the license portion of the dataset info from a LicenseInfo and an attribution. This is a convenience method to make sure all parts of the object are set correctly and in sync.

Parameters:

licenseInfo - the license info about this dataset's license

attribution - the attribution for this license. This is required when licenseInfo.attributionRequired is true

attributionLink - a link for the attribution for this license. This is recommended when licenseInfo.attributionRequired is true

getLicense

public License getLicense()

Gets the license structure that defines this license. This should describe the license specified in the licenseId field.

Returns:

the license structure for this license.

setLicense

public void setLicense(License license)

Sets the license structure that defines this license. This should describe the license specified in the licenseId field.

getLicenseId

public String getLicenseId()

The unique ID for the license that applies to this dataset. Look at the LicenseInfo enum for a list of the license IDs.

Returns:

unique id for the license for this dataset.

setLicenseId

public void setLicenseId(String licenseId)

The unique ID for the license that applies to this dataset. Look at the LicenseInfo enum for a list of the license IDs.

Parameters:

licenseId - unique id for the license for this dataset.

getMetadata

public Metadata getMetadata()

Gets the metadata for this dataset

Returns:

metadata object for this dataset

setMetadata

public void setMetadata(Metadata metadata)

Sets the metadata for this dataset

Parameters:

metadata - metadata object for this dataset

getName

public String getName()

Gets the human readable name for this dataset.

Returns:

human readable name for this dataset.

setName

public void setName(String name)

Gets the human readable name for this dataset.

Parameters:

name - human readable name for this dataset.

getPrivateMetadata

public Map<String,Object> getPrivateMetadata()

Gets private metadata for this dataset. Private metadata is metadata that is not viewable by the general public.

Returns:

the private metadata for this dataset

setPrivateMetadata

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

Sets private metadata for this dataset. Private metadata is metadata that is not viewable by the general public.

Parameters:

privateMetadata - the private metadata for this dataset

getPublicationStage

public String getPublicationStage()

Returns whether this dataset is in a published or unpublished state.

Returns:

"published" if this dataset is published "unpublished" if this dataset is not published

setPublicationStage

public void setPublicationStage(String publicationStage)

This should really only be called by the system. To publish a dataset or create a working copy, look at the SodaWorkflow object, particularly at the methods publish and createWorkingCopy

Parameters:

publicationStage - "published" if this dataset is published "unpublished" if this dataset is not published

getRights

public List<String> getRights()

setRights

public void setRights(List<String> rights)

getRowsUpdatedAt

public Long getRowsUpdatedAt()

A long representing the seconds since the epoch till this was modified. NOTE: THis is seconds since the epoch, not millis. So turning into a standard Date requires multiplying by 1000.

Returns:

A long representing the seconds since the epoch till this was modified.

setRowsUpdatedAt

public void setRowsUpdatedAt(Long rowsUpdatedAt)

This method should only be called by the system, since the system is responsible for setting the modified date.

Parameters:

rowsUpdatedAt - A long representing the seconds since the epoch till this was modified.

getTags

public List<String> getTags()

Gets the list of freeform tags describing this dataset.

Returns:

the list of freeform tags describing this dataset.

setTags

public void setTags(List<String> tags)

Gets the list of freeform tags describing this dataset.

getGrants

public List<Grant> getGrants()

Gets all the permission grants for this dataset. This will include a grant to make the dataset public, or any explicit sharing with another user. May be null if there are no grants. This state is teh same as a dataset being private.

Returns:

list of grants

setGrants

public void setGrants(List<Grant> grants)

Sets all the permission grants for this dataset. This is an accessor on this class, but to actually make a dataset public or private, you should use the makePublic and makePrivate methods in SodaWorkflow