SegmentByText

Generalization is PhysicalSegmentLocation.

Superclass hierarchy

Definition

Location of a segment of text through character or line counts.

Examples

The segment beginning at line 3, character 4 and ending at line 27 character 13. Alternatively the segment beginning at character 257 and ending at character 1350 of the whole body of text. StartLine of 10, endLine of 12, startCharacterPosition of 1, endCharacterPosition of 0 means all of lines 10, 11, and 12. An endCharacterPosition of 0 indicates that whole lines are specified.

Explanatory notes

An adequate description will always include a startCharacterPosition and then may include an endCharacterPosition or a characterLength. If StartLine is specified, the character counts begin within that line.


Subclasses


Properties

Name

Description

Data Type

Multi- plicity

characterLength

The number of characters in the segment. The segment may include text from multiple lines of the resource. If it does, the length includes any line termination characters.

:ref:``

0..1

endCharacterPosition

The character position of the last character of the segment. If endLine is specified, the count begins at character 1 of endLine. If startLine and endLine are not specified, the count begins at character 1 of the first line of the resource and the count includes any line termination characters. The resulting segment may include text from multiple lines of the resource.

:ref:``

0..1

endLine

The last line on which to count characters. If missing this defaults to startLine.

:ref:``

0..1

startCharacterPosition

The character position of the first character of the segment, with the count beginning at character 1 of startLine.

:ref:``

0..1

startLine

The line number, where 1 is the first line, on which to begin counting characters. If missing this defaults to 1 (the first line).

:ref:``

0..1

Inherited Properties

Name

Description

Data Type

Multi- plicity

agency

Agency expressed as filed with the DDI Agency ID registry [registry.ddialliance.org] with optional additional sub-agency extensions.

:ref:``

1..1

id

ID conforming to the allowed structure of the DDI Identifier and must be unique within the Agency.

:ref:``

1..1

isPersistent

Default value is false indicating that the content of the current version may change (may be in development mode). Set to true when the content of this version will no longer change.

:ref:``

1..1

isUniversallyUnique

Default value is false. If the id of the object was created as a Universally Unique ID (UUID) set to true.

:ref:``

1..1

localId

Locally used identifier unique with a specified context, such as a variable name within a dataset.

LocalIdFormat

0..*

version

Version number of the object.

:ref:``

1..1

versionDate

Date and time the object was changed expressed in standard ISO formats.

XSDdate

0..1

versionRationale

Reason for making a new version of the object.

RationaleDefinition

0..1

versionResponsibility

Contributor who has the ownership and responsibility for the current version.

:ref:``

0..1

Diagram

TBD