distribution module

This is the distribution module.

This module contains geographic metadata structures regarding data distribution derived from the ISO 19115-1:2014 international standard.

DataFile

Bases: ABC

Description of a transfer data file.

Source code in opengis/metadata/distribution.py

class DataFile(ABC):
    """Description of a transfer data file."""

    @property
    @abstractmethod
    def file_name(self):
        """Name of the file that contains the data."""

    @property
    @abstractmethod
    def file_description(self) -> str:
        """Text description of the data."""

    @property
    @abstractmethod
    def file_type(self) -> str:
        """Format in which the data is encoded."""

    @property
    @abstractmethod
    def feature_types(self) -> Sequence[GenericName]:
        """
        Provides the list of feature types concerned by the transfer data file.
        """

feature_types: Sequence[GenericName] abstractmethod property

Provides the list of feature types concerned by the transfer data file.

file_description: str abstractmethod property

Text description of the data.

file_name abstractmethod property

Name of the file that contains the data.

file_type: str abstractmethod property

Format in which the data is encoded.

DigitalTransferOptions

Bases: ABC

Technical means and media by which a resource is obtained from the distributor.

Source code in opengis/metadata/distribution.py

class DigitalTransferOptions(ABC):
    """
    Technical means and media by which a resource is obtained from the
    distributor.
    """

    @property
    @abstractmethod
    def units_of_distribution(self) -> Optional[str]:
        """
        Tiles, layers, geographic areas, etc., in which data is available.

        NOTE: units_of_distribution applies to both onLine and offLine
        distributions.
        """

    @property
    @abstractmethod
    def transfer_size(self) -> Optional[float]:
        """
        Estimated size of a unit in the specified transfer format, expressed
        in megabytes.

        NOTE: The transfer size is > 0.0.

        Domain: > 0.0
        """

    @property
    @abstractmethod
    def on_line(self) -> Optional[Sequence[OnlineResource]]:
        """
        Information about online sources from which the resource can be
        obtained.
        """

    @property
    @abstractmethod
    def off_line(self) -> Optional[Sequence[Medium]]:
        """
        Information about offline media on which the resource can be obtained.
        """

    @property
    @abstractmethod
    def transfer_frequency(self) -> Optional[timedelta]:
        """Rate of occurrence of distribution."""

    @property
    @abstractmethod
    def distribution_format(self) -> Optional[Sequence[Format]]:
        """Format of distribution."""

distribution_format: Optional[Sequence[Format]] abstractmethod property

Format of distribution.

off_line: Optional[Sequence[Medium]] abstractmethod property

Information about offline media on which the resource can be obtained.

on_line: Optional[Sequence[OnlineResource]] abstractmethod property

Information about online sources from which the resource can be obtained.

transfer_frequency: Optional[timedelta] abstractmethod property

Rate of occurrence of distribution.

transfer_size: Optional[float] abstractmethod property

Estimated size of a unit in the specified transfer format, expressed in megabytes.

NOTE: The transfer size is > 0.0.

Domain: > 0.0

units_of_distribution: Optional[str] abstractmethod property

Tiles, layers, geographic areas, etc., in which data is available.

NOTE: units_of_distribution applies to both onLine and offLine distributions.

Distribution

Bases: ABC

Information about the distributor of and options for obtaining the resource.

Source code in opengis/metadata/distribution.py

class Distribution(ABC):
    """
    Information about the distributor of and options for obtaining the
    resource.
    """

    @property
    @abstractmethod
    def description(self) -> Optional[str]:
        """Brief description of a set of distribution options."""

    @property
    @abstractmethod
    def distribution_format(self) -> Optional[Sequence[Format]]:
        """
        Provides the description of the format of the data to be distributed.
        """

    @property
    @abstractmethod
    def distributor(self) -> Optional[Sequence[Distributor]]:
        """Provides information about the distributor."""

    @property
    @abstractmethod
    def transfer_options(self) -> Optional[Sequence['DigitalTransferOptions']]:
        """
        Provides information about technical means and media by which a
        resource is obtained from the distributor.
        """

description: Optional[str] abstractmethod property

Brief description of a set of distribution options.

distribution_format: Optional[Sequence[Format]] abstractmethod property

Provides the description of the format of the data to be distributed.

distributor: Optional[Sequence[Distributor]] abstractmethod property

Provides information about the distributor.

transfer_options: Optional[Sequence[DigitalTransferOptions]] abstractmethod property

Provides information about technical means and media by which a resource is obtained from the distributor.

Distributor

Bases: ABC

Information about the distributor.

Source code in opengis/metadata/distribution.py

class Distributor(ABC):
    """Information about the distributor."""

    @property
    @abstractmethod
    def distributor_contact(self) -> Responsibility:
        """
        Party from whom the resource may be obtained. This list need not be
        exhaustive.
        """

    @property
    @abstractmethod
    def distribution_order_process(self) -> Optional[Sequence[
        StandardOrderProcess
    ]]:
        """
        Provides information abouthowthe resource may be obtained and related
        instructions and fee information.
        """

    @property
    @abstractmethod
    def distributor_format(self) -> Optional[Sequence[Format]]:
        """Provides information about the format used by the distributor."""

    @property
    @abstractmethod
    def distributor_transfer_options(self) -> Optional[Sequence[
        'DigitalTransferOptions'
    ]]:
        """
        Provides information about the technical means and media used by
        the distributor.
        """

distribution_order_process: Optional[Sequence[StandardOrderProcess]] abstractmethod property

Provides information abouthowthe resource may be obtained and related instructions and fee information.

distributor_contact: Responsibility abstractmethod property

Party from whom the resource may be obtained. This list need not be exhaustive.

distributor_format: Optional[Sequence[Format]] abstractmethod property

Provides information about the format used by the distributor.

distributor_transfer_options: Optional[Sequence[DigitalTransferOptions]] abstractmethod property

Provides information about the technical means and media used by the distributor.

Format

Bases: ABC

Description of the computer language construct that specifies the representation of data objects in a record, file, message, storage device or transmission channel.

Source code in opengis/metadata/distribution.py

class Format(ABC):
    """
    Description of the computer language construct that specifies the
    representation of data objects in a record, file, message, storage device
    or transmission channel.
    """

    @property
    @abstractmethod
    def format_specification_citation(self) -> Citation:
        """Citation/URL of the specification for the format."""

    @property
    @abstractmethod
    def amendment_number(self) -> Optional[str]:
        """Amendment number of the format version."""

    @property
    @abstractmethod
    def file_decompression_technique(self) -> Optional[str]:
        """
        Recommendations of algorithms or processes that can be applied to read
        or expand resources to which compression techniques have been applied.
        """

    @property
    @abstractmethod
    def medium(self) -> Optional[Sequence[Medium]]:
        """Medium used by the format."""

    @property
    @abstractmethod
    def format_distributor(self) -> Optional[Sequence['Distributor']]:
        """Provides information about the distributor of the format."""

amendment_number: Optional[str] abstractmethod property

Amendment number of the format version.

file_decompression_technique: Optional[str] abstractmethod property

Recommendations of algorithms or processes that can be applied to read or expand resources to which compression techniques have been applied.

format_distributor: Optional[Sequence[Distributor]] abstractmethod property

Provides information about the distributor of the format.

format_specification_citation: Citation abstractmethod property

Citation/URL of the specification for the format.

medium: Optional[Sequence[Medium]] abstractmethod property

Medium used by the format.

Medium

Bases: ABC

Information about the media on which the resource can be distributed.

Source code in opengis/metadata/distribution.py

class Medium(ABC):
    """Information about the media on which the resource can be distributed."""

    @property
    @abstractmethod
    def name(self) -> Optional[Citation]:
        """Name of the medium on which the resource can be received."""

    @property
    @abstractmethod
    def density(self) -> Optional[float]:
        """
        Density at which the data is recorded.

        Domain: > 0.0
        """

    @property
    @abstractmethod
    def density_units(self) -> Optional[str]:
        """Units of measure for the recording density."""

    @property
    @abstractmethod
    def volumes(self) -> Optional[int]:
        """
        Number of items in the media identified.

        Domain: > 0
        """

    @property
    @abstractmethod
    def medium_format(self) -> Optional[Sequence[MediumFormatCode]]:
        """Method used to write to the medium."""

    @property
    @abstractmethod
    def medium_note(self) -> Optional[str]:
        """
        Description of other limitations or requirements for using the medium.
        """

    @property
    @abstractmethod
    def identifier(self) -> Optional[Identifier]:
        """Unique identifier for an instance of the `Medium`."""

density: Optional[float] abstractmethod property

Density at which the data is recorded.

Domain: > 0.0

density_units: Optional[str] abstractmethod property

Units of measure for the recording density.

identifier: Optional[Identifier] abstractmethod property

Unique identifier for an instance of the Medium.

medium_format: Optional[Sequence[MediumFormatCode]] abstractmethod property

Method used to write to the medium.

medium_note: Optional[str] abstractmethod property

Description of other limitations or requirements for using the medium.

name: Optional[Citation] abstractmethod property

Name of the medium on which the resource can be received.

volumes: Optional[int] abstractmethod property

Number of items in the media identified.

Domain: > 0

MediumFormatCode

Bases: Enum

Method used to write to the medium.

Source code in opengis/metadata/distribution.py

class MediumFormatCode(Enum):
    """Method used to write to the medium."""

    CPIO = "cpio"
    """Copy In / Out (UNIX file format and command)."""

    TAR = "tar"
    """Tape Archive."""

    HIGH_SIERRA = "highSierra"
    """High sierra file system."""

    ISO_9660 = "iso9660"
    """Information processing - volume and file structure of CD-ROM."""

    ISO_9660_ROCK_RIDGE = "iso9660RockRidge"
    """Rock ridge interchange protocol (UNIX)."""

    ISO_9660_APPLE_HFS = "iso9660AppleHFS"
    """Hierarchical file system (Macintosh)."""

    UDF = "udf"
    """Universal disk format."""

CPIO = 'cpio' class-attribute instance-attribute

Copy In / Out (UNIX file format and command).

HIGH_SIERRA = 'highSierra' class-attribute instance-attribute

High sierra file system.

ISO_9660 = 'iso9660' class-attribute instance-attribute

Information processing - volume and file structure of CD-ROM.

ISO_9660_APPLE_HFS = 'iso9660AppleHFS' class-attribute instance-attribute

Hierarchical file system (Macintosh).

ISO_9660_ROCK_RIDGE = 'iso9660RockRidge' class-attribute instance-attribute

Rock ridge interchange protocol (UNIX).

TAR = 'tar' class-attribute instance-attribute

Tape Archive.

UDF = 'udf' class-attribute instance-attribute

Universal disk format.

StandardOrderProcess

Bases: ABC

Common ways in which the resource may be obtained or received, and related instructions and fee information.

Source code in opengis/metadata/distribution.py

class StandardOrderProcess(ABC):
    """
    Common ways in which the resource may be obtained or received, and related
    instructions and fee information.
    """

    @property
    @abstractmethod
    def fees(self) -> Optional[str]:
        """
        Fees and terms for retrieving the resource. Include monetary units
        (as specified in ISO 4217).
        """

    @property
    @abstractmethod
    def planned_available_date_time(self) -> Optional[datetime]:
        """Date and time when the resource will be available."""

    @property
    @abstractmethod
    def ordering_instructions(self) -> Optional[str]:
        """
        General instructions, terms and services provided by the distributor.
        """

    @property
    @abstractmethod
    def turnaround(self) -> Optional[str]:
        """Typical turnaround time for the filling of an order."""

    @property
    @abstractmethod
    def order_options_type(self) -> Optional[RecordType]:
        """Description of the order options record."""

    @property
    @abstractmethod
    def order_options(self) -> Optional[Record]:
        """Request/purchase choices."""

fees: Optional[str] abstractmethod property

Fees and terms for retrieving the resource. Include monetary units (as specified in ISO 4217).

order_options: Optional[Record] abstractmethod property

Request/purchase choices.

order_options_type: Optional[RecordType] abstractmethod property

Description of the order options record.

ordering_instructions: Optional[str] abstractmethod property

General instructions, terms and services provided by the distributor.

planned_available_date_time: Optional[datetime] abstractmethod property

Date and time when the resource will be available.

turnaround: Optional[str] abstractmethod property

Typical turnaround time for the filling of an order.