isogeo_pysdk.models.feature_attributes module

Isogeo API v1 - Model of FeatureAttributes entity

See: http://help.isogeo.com/api/complete/index.html

class isogeo_pysdk.models.feature_attributes.FeatureAttribute(_id=None, alias=None, comment=None, dataType=None, description=None, isAutoGenerated=None, isNullable=None, isReadOnly=None, hasElevation=None, hasMeasure=None, language=None, length=None, name=None, precision=None, propertyType=None, scale=None, spatialContext=None, parent_resource=None)

Bases: object

FeatureAttributes are entities included as subresource into metadata.

Parameters

_id (str) – UUID, defaults to None
alias (str) – alias of the feature attribute, defaults to None
comment (str) – comment of the feature attribute, defaults to None
dataType (str) – kind of field (varchar, integer32…), defaults to None
description (str) – description of the feature attribute, defaults to None
language (str) – language of the description, defaults to None
length (int) – length of the values accepted in the attribute, defaults to None
name (str) – attribute name, defaults to None
precision (int) – value precision, defaults to None
scale (int) – scale of display, defaults to None

Example

{
    "_id": string (uuid),
    "alias": string,
    "comment": string,
    "dataType": string,
    "description": string,
    "language": string,
    "length": int,
    "name": string,
    "precision": int,
    "scale": int,
}

ATTR_CREA = {'alias': <class 'str'>, 'comment': <class 'str'>, 'dataType': <class 'str'>, 'description': <class 'str'>, 'hasElevation': <class 'bool'>, 'hasMeasure': <class 'bool'>, 'isAutoGenerated': <class 'bool'>, 'isNullable': <class 'bool'>, 'isReadOnly': <class 'bool'>, 'language': <class 'str'>, 'length': <class 'int'>, 'name': <class 'str'>, 'precision': <class 'int'>, 'propertyType': <class 'str'>, 'scale': <class 'int'>, 'spatialContext': <class 'str'>}

ATTR_MAP = {}

ATTR_TYPES = {'_id': <class 'str'>, 'alias': <class 'str'>, 'comment': <class 'str'>, 'dataType': <class 'str'>, 'description': <class 'str'>, 'hasElevation': <class 'bool'>, 'hasMeasure': <class 'bool'>, 'isAutoGenerated': <class 'bool'>, 'isNullable': <class 'bool'>, 'isReadOnly': <class 'bool'>, 'language': <class 'str'>, 'length': <class 'int'>, 'name': <class 'str'>, 'parent_resource': <class 'str'>, 'precision': <class 'int'>, 'propertyType': <class 'str'>, 'scale': <class 'int'>, 'spatialContext': <class 'str'>}

property alias: str

Gets the alias of this FeatureAttribute.

Returns: The alias of this FeatureAttribute.
Return type: str

property comment: str

Gets the comment of this FeatureAttribute.

Returns: The comment of this FeatureAttribute.
Return type: str

property dataType: str

Gets the dataType of this FeatureAttribute.

Returns: The dataType of this FeatureAttribute.
Return type: str

property description: str

Gets the description of this FeatureAttribute.

Returns: The description of this FeatureAttribute.
Return type: str

property hasElevation: bool

Gets the hasElevation of this FeatureAttribute.

Returns: The hasElevation of this FeatureAttribute.
Return type: bool

property hasMeasure: bool

Gets the hasMeasure of this FeatureAttribute.

Returns: The hasMeasure of this FeatureAttribute.
Return type: bool

property isAutoGenerated: bool

Gets the isAutoGenerated of this FeatureAttribute.

Returns: The isAutoGenerated of this FeatureAttribute.
Return type: bool

property isNullable: bool

Gets the isNullable of this FeatureAttribute.

Returns: The isNullable of this FeatureAttribute.
Return type: bool

property isReadOnly: bool

Gets the isReadOnly of this FeatureAttribute.

Returns: The isReadOnly of this FeatureAttribute.
Return type: bool

property language: str

Gets the language of this FeatureAttribute.

Returns: The language of this FeatureAttribute.
Return type: str

property length: int

Gets the length of this FeatureAttribute.

Returns: The length of this FeatureAttribute.
Return type: int

property name: str

Gets the name of this FeatureAttribute.

Returns: The name of this FeatureAttribute.
Return type: str

property precision: int

Gets the precision of this FeatureAttribute.

Returns: The precision of this FeatureAttribute.
Return type: int

property propertyType: str

Gets the propertyType of this FeatureAttribute.

Returns: The propertyType of this FeatureAttribute.
Return type: str

property scale: int

Gets the scale of this FeatureAttribute.

Returns: The scale of this FeatureAttribute.
Return type: int

property spatialContext: str

Gets the spatialContext of this FeatureAttribute.

Returns: The spatialContext of this FeatureAttribute.
Return type: str

to_dict()

Returns the model properties as a dict.

Return type: dict

to_dict_creation()

Returns the model properties as a dict structured for creation purpose (POST)

Return type: dict

to_str()

Returns the string representation of the model.

Return type: str