CDIFManifest

TabularTextDataSet

CDIFManifest::Classes::TabularTextDataSet

Definition

Documentation

Original
Reference

cdi:TabularTextDataSet

Definition

Definition

Information describing the physical aspects of a data set which is encoded using a text-based method and which has an essentially tabular structure.

Examples

A table formatted as a comma separated values (CSV) file; a pipe-delimited ASCII data file such as the tract definitions for the US 2020 Census (found at https://www2.census.gov/geo/docs/maps-data/data/rel2020/tract/tab20_tract20_tract10_natl.txt); any similar file which used fixed-width columns instead of delimiters.

Explanatory notes

A tabular text data set is a physical description (e.g. unit segment layout) of the instance variables making up the records in the data set. Each instance variable has a text mapping linking it to the physical layout, with a position index supplied by a physical mapping position object. Tabular text data sets are distinct from binary data sets which do not use a text-based encoding, and from more structured text-based data expressed in formats such as XML, JSON, or any of the RDF representations.

CDIF
Definition

ArchivePart co-typed cdi:TabularTextDataSet. Carries CSV-style layout attributes.

Diagram

Inheritance

Generalizes: AbstractDataSet

Attributes

NameTypeMultiplicityDescription
delimiterstring[0..1]

Documentation

Original
Reference

cdi:TabularTextDataSet-delimiter

Definition

The Delimiting character in the data. Must be used if isDelimited is True. "The separator between cells, set by the delimiter property of a dialect description. The default is ,. See the W3C Recommendation "Metadata Vocabulary for Tabular Data" (https://www.w3.org/TR/tabular-data-model/#encoding). From the "CSV Dialect" specification (https://specs.frictionlessdata.io/csv-dialect/#specification): "delimiter: specifies a one-character string to use as the field separator. Default = ,."

CDIF
Definition

csvw:delimiter.

isDelimitedboolean[0..1]

Documentation

Original
Reference

cdi:TabularTextDataSet-isDelimited

Definition

Indicates whether the data are in a delimited format. If "true," the format is delimited, and the isFixedWidth property must be set to "false." If not set to "true," the property isFixedWitdh must be set to "true."

CDIF
Definition

Schema constraint is that one of {'isDelimited','isFixedWidth'} must be present with a True value; the other one may be present or omitted, but if present must have a false value.

Scope

cdi:isDelimited.

isFixedWidthboolean[0..1]

Documentation

Original
Reference

cdi:TabularTextDataSet-isFixedWidth

Definition

Set to true if the file is fixed-width. If true, isDelimited must be set to false.

CDIF
Definition

cdi:isFixedWidth.

headerIsCaseSensitiveboolean[0..1]

Documentation

Original
Reference

cdi:TabularTextDataSet-headerIsCaseSensitive

Definition

If True, the case of the labels in the header is significant. From the "CSV Dialect" specification (http://specs.frictionlessdata.io/csv-dialect/): "caseSensitiveHeader: indicates that case in the header is meaningful. For example, columns CAT and Cat should not be equated. Default = false."

CDIF
Definition

Whether column header names are case-sensitive. From DDI-CDI PhysicalSegmentLayout.headerIsCaseSensitive.

Scope

cdi:headerIsCaseSensitive.

treatConsecutiveDelimitersAsOneboolean[0..1]

Documentation

Original
Reference

cdi:TabularTextDataSet-treatConsecutiveDelimitersAsOne

Definition

If the value is True, consecutive (adjacent) delimiters are treated as a single delimiter; if the value is False consecutive (adjacent) delimiters indicate a missing value.

CDIF
Definition

Whether consecutive delimiters should be treated as a single delimiter. From DDI-CDI PhysicalSegmentLayout.treatConsecutiveDelimitersAsOne.

Scope

cdi:treatConsecutiveDelimitersAsOne.

escapeCharacterstring[0..1]

Documentation

Original
Reference

cdi:TabularTextDataSet-escapeCharacter

Definition

"The string that is used to escape the quote character within escaped cells, or null" see https://www.w3.org/TR/tabular-data-model/#encoding. From https://www.w3.org/TR/tabular-metadata/ 5.9 Dialect "doubleQuote: A boolean atomic property that, if true, sets the escape character flag to ". If false, to \. The default is true." From http://specs.frictionlessdata.io/csv-dialect/ "doubleQuote: controls the handling of quotes inside fields. If true, two consecutive quotes should be interpreted as one. Default = true".

CDIF
Definition

The character used to escape special characters in the data. From DDI-CDI PhysicalSegmentLayout.escapeCharacter.

Scope

cdi:escapeCharacter.

Associations

No associations.