Hydrologic Formation Segment in ESG data model
Base entity from which all Industry Data Model entities are derived.
Traits
Traits for this entity are listed here.
is.CDM.entityVersion
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| versionNumber | "4.3" | string | semantic version number of the entity |
is.localized.describedAs
Holds the list of language specific descriptive text for an object.
| Parameter | Value | Data type | Explanation | ||||||
|---|---|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.identifiedBy
Names a specific identity attribute to use with an entity.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| attribute | HydrologicFormationSegment/(resolvedAttributes)/HydrologicFormationSegmentId | attribute |
minimumObjectModelVersion
Minimum version of the object model required to fully understand the data schema used.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| versionNumber | "1.2.3" | string |
is.IDM.modelVersion
Semantic version number of the IDM.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| versionNumber | "1.6.0" | string |
has.schemaObjectIdentifier
The schema object has an identifier, which is a string, specified as the parameter of the trait. It allows writers to define other identification values.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| identifier | "{0E3D1276-4A2C-4B88-8C3B-96A3C42D7A29}" | string | The identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema. |
is.nativeTo.businessArea
The name of the business area from which the entity originates.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| name | "Water Management" | string |
is.localized.displayedAs
Holds the list of language specific display text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
has.entitySchemaAbstractionLevel
A level of abstraction assigned to an Entity schema. Logical schema descriptions use complex dataTypes, inheritance, and entities as attributes. Resolved descriptions contain none of those things, only final trait and attribute sets are shown. A composition schema manipulates, guides or restates parts of logical schemas to produce one resolved schema.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| level | "resolved" | string | Possible values: logical, composition, resolved |
Attributes
| Name | Description | First Included in Instance |
|---|---|---|
| HydrologicFormationId | The unique identifier of a Hydrologic Formation. | HydrologicFormationSegment |
| HydrologicFormationSegmentId | The unique identifier of a hydrologic formation segment. | HydrologicFormationSegment |
| HydrologicFormationName | The name of the hydrologic formation. | HydrologicFormationSegment |
| HydrologicFormationDescription | The description of the hydrologic formation. | HydrologicFormationSegment |
| HydrologicFormationSegmentLengthKm | The length of the hydrologic segment. | HydrologicFormationSegment |
| HydrologicFormationStartLatitude | The hydrologic segment start latitude. | HydrologicFormationSegment |
| HydrologicFormationStartLongitude | The hydrologic segment start longitude. | HydrologicFormationSegment |
| HydrologicFormationEndLatitude | The hydrologic segment end latitude. | HydrologicFormationSegment |
| HydrologicFormationEndLongitude | The hydrologic segment end longitude. | HydrologicFormationSegment |
| HydrologicFormationGradientDegrees | The vertical distance that hydrologic formation falls while traveling the length of the segment. | HydrologicFormationSegment |
| GaugeStationId | The unique identifier of a gaging station. **Example:**A U.S. Geological Survey (USGS) numbering system consisting of an eight-digit number assigned to a Gauge Station which identifies the station in downstream order relative to other gaging stations and sites where streamflow data are collected. The first two digits designate the major drainage basin, the others the station. | HydrologicFormationSegment |
HydrologicFormationId
The unique identifier of a Hydrologic Formation.
First included in: HydrologicFormationSegment (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Hydrologic Formation ID |
| description | The unique identifier of a Hydrologic Formation. |
| isPrimaryKey | true |
| dataFormat | int64 |
Traits
List of traits for the HydrologicFormationId attribute are listed here.
is.dataFormat.integer
is.dataFormat.big
Indicates an atomic but multi-unit version of a fundamental type such as a multi byte encoded character, a double precision float, a long integer.
is.identifiedBy
Names a specific identity attribute to use with an entity.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| attribute | HydrologicFormationSegment/(resolvedAttributes)/HydrologicFormationId | attribute |
is.linkedEntity.identifier
Marks the attribute(s) that hold foreign key references to a linked (used as an attribute) entity. This attribute is added to the resolved entity to enumerate the referenced entities.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| entityReferences |
| entity | a reference to the constant entity holding the list of entity references |
is.localized.displayedAs
Holds the list of language specific display text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.localized.describedAs
Holds the list of language specific descriptive text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
has.schemaObjectIdentifier
The schema object has an identifier, which is a string, specified as the parameter of the trait. It allows writers to define other identification values.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| identifier | "{A6440F00-CD30-4440-A421-ECEEA9388995}" | string | The identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema. |
is.dataFormat.integer
is.dataFormat.big
Indicates an atomic but multi-unit version of a fundamental type such as a multi byte encoded character, a double precision float, a long integer.
HydrologicFormationSegmentId
The unique identifier of a hydrologic formation segment.
First included in: HydrologicFormationSegment (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Hydrologic Formation Segment ID |
| description | The unique identifier of a hydrologic formation segment. |
| isPrimaryKey | true |
| dataFormat | int32 |
Traits
List of traits for the HydrologicFormationSegmentId attribute are listed here.
is.dataFormat.integer
is.identifiedBy
Names a specific identity attribute to use with an entity.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| attribute | HydrologicFormationSegment/(resolvedAttributes)/HydrologicFormationSegmentId | attribute |
has.schemaObjectIdentifier
The schema object has an identifier, which is a string, specified as the parameter of the trait. It allows writers to define other identification values.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| identifier | "{15D59446-E61D-40EE-ADAB-E4B70AF98591}" | string | The identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema. |
is.localized.displayedAs
Holds the list of language specific display text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.localized.describedAs
Holds the list of language specific descriptive text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.dataFormat.integer
HydrologicFormationName
The name of the hydrologic formation.
First included in: HydrologicFormationSegment (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Hydrologic Formation Name |
| description | The name of the hydrologic formation. |
| dataFormat | string |
| maximumLength | 256 |
| isNullable | true |
Traits
List of traits for the HydrologicFormationName attribute are listed here.
is.dataFormat.character
is.dataFormat.big
Indicates an atomic but multi-unit version of a fundamental type such as a multi byte encoded character, a double precision float, a long integer.
is.dataFormat.array
Indicates a contiguous sequence of fundamental units that should be taken as a whole and considered one value. Array of Character is a String. Array of Byte is a Binary Object.
has.schemaObjectIdentifier
The schema object has an identifier, which is a string, specified as the parameter of the trait. It allows writers to define other identification values.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| identifier | "{D6EA1206-CA40-440E-84E7-59B0A216885E}" | string | The identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema. |
is.nullable
The attribute value can be set to NULL.
is.localized.displayedAs
Holds the list of language specific display text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.localized.describedAs
Holds the list of language specific descriptive text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.constrained
Maximum length or value constraints.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| maximumLength | "256" | integer |
is.dataFormat.character
is.dataFormat.array
Indicates a contiguous sequence of fundamental units that should be taken as a whole and considered one value. Array of Character is a String. Array of Byte is a Binary Object.
HydrologicFormationDescription
The description of the hydrologic formation.
First included in: HydrologicFormationSegment (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Hydrologic Formation Description |
| description | The description of the hydrologic formation. |
| dataFormat | string |
| maximumLength | 2048 |
| isNullable | true |
Traits
List of traits for the HydrologicFormationDescription attribute are listed here.
is.dataFormat.character
is.dataFormat.big
Indicates an atomic but multi-unit version of a fundamental type such as a multi byte encoded character, a double precision float, a long integer.
is.dataFormat.array
Indicates a contiguous sequence of fundamental units that should be taken as a whole and considered one value. Array of Character is a String. Array of Byte is a Binary Object.
has.schemaObjectIdentifier
The schema object has an identifier, which is a string, specified as the parameter of the trait. It allows writers to define other identification values.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| identifier | "{99DEAC96-BEDB-4848-9475-82380A68E359}" | string | The identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema. |
is.nullable
The attribute value can be set to NULL.
is.localized.displayedAs
Holds the list of language specific display text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.localized.describedAs
Holds the list of language specific descriptive text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.constrained
Maximum length or value constraints.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| maximumLength | "2048" | integer |
is.dataFormat.character
is.dataFormat.array
Indicates a contiguous sequence of fundamental units that should be taken as a whole and considered one value. Array of Character is a String. Array of Byte is a Binary Object.
HydrologicFormationSegmentLengthKm
The length of the hydrologic segment.
First included in: HydrologicFormationSegment (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Hydrologic Formation Segment Length km |
| description | The length of the hydrologic segment. |
| dataFormat | int32 |
| isNullable | true |
Traits
List of traits for the HydrologicFormationSegmentLengthKm attribute are listed here.
is.dataFormat.integer
has.schemaObjectIdentifier
The schema object has an identifier, which is a string, specified as the parameter of the trait. It allows writers to define other identification values.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| identifier | "{4EB7C5FF-D9D9-41A1-A8E6-0593C96DDCA2}" | string | The identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema. |
is.nullable
The attribute value can be set to NULL.
is.localized.displayedAs
Holds the list of language specific display text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.localized.describedAs
Holds the list of language specific descriptive text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.dataFormat.integer
HydrologicFormationStartLatitude
The hydrologic segment start latitude.
First included in: HydrologicFormationSegment (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Hydrologic Formation Start Latitude |
| description | The hydrologic segment start latitude. |
| dataFormat | decimal |
| isNullable | true |
Traits
List of traits for the HydrologicFormationStartLatitude attribute are listed here.
is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| precision | "10" | integer | the total number of significant digits |
| scale | "7" | integer | the number of digits to the right of the decimal place |
has.schemaObjectIdentifier
The schema object has an identifier, which is a string, specified as the parameter of the trait. It allows writers to define other identification values.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| identifier | "{A470D8F1-A448-4FEE-8E84-C29B0DDE276D}" | string | The identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema. |
is.nullable
The attribute value can be set to NULL.
is.localized.displayedAs
Holds the list of language specific display text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.localized.describedAs
Holds the list of language specific descriptive text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values
HydrologicFormationStartLongitude
The hydrologic segment start longitude.
First included in: HydrologicFormationSegment (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Hydrologic Formation Start Longitude |
| description | The hydrologic segment start longitude. |
| dataFormat | decimal |
| isNullable | true |
Traits
List of traits for the HydrologicFormationStartLongitude attribute are listed here.
is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| precision | "10" | integer | the total number of significant digits |
| scale | "7" | integer | the number of digits to the right of the decimal place |
has.schemaObjectIdentifier
The schema object has an identifier, which is a string, specified as the parameter of the trait. It allows writers to define other identification values.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| identifier | "{207585C2-59AE-4968-B1AC-49E746B6B9C4}" | string | The identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema. |
is.nullable
The attribute value can be set to NULL.
is.localized.displayedAs
Holds the list of language specific display text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.localized.describedAs
Holds the list of language specific descriptive text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values
HydrologicFormationEndLatitude
The hydrologic segment end latitude.
First included in: HydrologicFormationSegment (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Hydrologic Formation End Latitude |
| description | The hydrologic segment end latitude. |
| dataFormat | decimal |
| isNullable | true |
Traits
List of traits for the HydrologicFormationEndLatitude attribute are listed here.
is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| precision | "10" | integer | the total number of significant digits |
| scale | "7" | integer | the number of digits to the right of the decimal place |
has.schemaObjectIdentifier
The schema object has an identifier, which is a string, specified as the parameter of the trait. It allows writers to define other identification values.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| identifier | "{5ED49E30-8886-4E1F-9218-6582805FA57D}" | string | The identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema. |
is.nullable
The attribute value can be set to NULL.
is.localized.displayedAs
Holds the list of language specific display text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.localized.describedAs
Holds the list of language specific descriptive text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values
HydrologicFormationEndLongitude
The hydrologic segment end longitude.
First included in: HydrologicFormationSegment (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Hydrologic Formation End Longitude |
| description | The hydrologic segment end longitude. |
| dataFormat | decimal |
| isNullable | true |
Traits
List of traits for the HydrologicFormationEndLongitude attribute are listed here.
is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| precision | "10" | integer | the total number of significant digits |
| scale | "7" | integer | the number of digits to the right of the decimal place |
has.schemaObjectIdentifier
The schema object has an identifier, which is a string, specified as the parameter of the trait. It allows writers to define other identification values.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| identifier | "{35426245-631D-4EB6-A906-62D0399E563B}" | string | The identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema. |
is.nullable
The attribute value can be set to NULL.
is.localized.displayedAs
Holds the list of language specific display text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.localized.describedAs
Holds the list of language specific descriptive text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values
HydrologicFormationGradientDegrees
The vertical distance that hydrologic formation falls while traveling the length of the segment.
First included in: HydrologicFormationSegment (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Hydrologic Formation Gradient Degrees |
| description | The vertical distance that hydrologic formation falls while traveling the length of the segment. |
| dataFormat | decimal |
| isNullable | true |
Traits
List of traits for the HydrologicFormationGradientDegrees attribute are listed here.
is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| precision | "18" | integer | the total number of significant digits |
| scale | "2" | integer | the number of digits to the right of the decimal place |
has.schemaObjectIdentifier
The schema object has an identifier, which is a string, specified as the parameter of the trait. It allows writers to define other identification values.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| identifier | "{1009E158-F815-4F07-98B4-9BBFF614E1E1}" | string | The identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema. |
is.nullable
The attribute value can be set to NULL.
is.localized.displayedAs
Holds the list of language specific display text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.localized.describedAs
Holds the list of language specific descriptive text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.dataFormat.numeric.shaped
for setting the exact precision and scale of numeric values
GaugeStationId
The unique identifier of a gaging station.
Example:
A U.S. Geological Survey (USGS) numbering system consisting of an eight-digit number assigned to a Gauge Station which identifies the station in downstream order relative to other gaging stations and sites where streamflow data are collected. The first two digits designate the major drainage basin, the others the station.
First included in: HydrologicFormationSegment (this entity)
Properties
| Name | Value |
|---|---|
| displayName | Gauge Station ID |
| description | The unique identifier of a gaging station.
Example: A U.S. Geological Survey (USGS) numbering system consisting of an eight-digit number assigned to a Gauge Station which identifies the station in downstream order relative to other gaging stations and sites where streamflow data are collected. The first two digits designate the major drainage basin, the others the station. |
| dataFormat | int32 |
| isNullable | true |
Traits
List of traits for the GaugeStationId attribute are listed here.
is.dataFormat.integer
has.schemaObjectIdentifier
The schema object has an identifier, which is a string, specified as the parameter of the trait. It allows writers to define other identification values.
| Parameter | Value | Data type | Explanation |
|---|---|---|---|
| identifier | "{04E5EF7C-7FE5-4DFD-820D-81CCB91C9F0A}" | string | The identifier for the schema object. There's no uniqueness guarantee enforced by CDM. It's a contract between reader and writer of the schema. |
is.nullable
The attribute value can be set to NULL.
is.localized.displayedAs
Holds the list of language specific display text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.localized.describedAs
Holds the list of language specific descriptive text for an object.
| Parameter | Value | Data type | Explanation | ||||
|---|---|---|---|---|---|---|---|
| localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.dataFormat.integer