class IFreeKeyword(IObject):
value = zope.schema.TextLine(
title=u"Keyword value",
description=
u"The keyword value is a commonly used word, formalised word or phrase used to describe the subject. While the topic category is too coarse for detailed queries, keywords help narrowing a full text search and they allow for structured keyword search.\nThe value domain of this metadata element is free text.",
required=False)
originating_vocabulary = zope.schema.TextLine(
title=u'Title',
description=
u"If the keyword value originates from a controlled vocabulary (thesaurus, ontology), for example GEMET, the citation of the originating controlled vocabulary shall be provided.\nThis citation shall include at least the title and a reference date (date of publication, date of last revision or of creation) of the originating controlled vocabulary.",
required=False)
reference_date = zope.schema.Date(title=u'Reference date', required=False)
date_type = zope.schema.Choice(
title=u'Date Type',
vocabulary=vocabularies.get_by_name('date-types').get('vocabulary'),
required=False)
@zope.interface.invariant
def check_mandatory_parts(obj):
if obj.value or obj.originating_vocabulary or obj.reference_date or obj.date_type:
if not obj.value or not obj.originating_vocabulary or not obj.reference_date or not obj.date_type:
raise zope.interface.Invalid(
'You need to fill in the rest free-keyword fields')
class IThesaurus(IObject):
name = zope.schema.NativeString(title=u'Name', required=True)
title = zope.schema.TextLine(title=u'Title', required=True)
reference_date = zope.schema.Date(title=u'Date', required=True)
date_type = zope.schema.Choice(
title = u"Date Type",
vocabulary = vocabularies.get_by_name('date-types').get('vocabulary'),
required = True)
version = zope.schema.NativeString(
title = u'Version',
constraint = re.compile('^\d+\.\d+(\.[a-z0-9]+)*$').match,
required = False)
vocabulary = zope.schema.Object(IVocabularyTokenized,
title = u'Vocabulary',
required = True)
@zope.interface.invariant
def check_vocabulary(obj):
''' Check that vocabulary provides an IVocabularyTokenized interface.
Note that, this cannot be done via IObject's field-wise validators because
target interface is not based on IObject.
'''
try:
verifyObject(IVocabularyTokenized, obj.vocabulary)
except Exception as ex:
raise zope.interface.Invalid('Not a vocabulary: %s' %(str(ex)))
class IConformity(IObject):
title = zope.schema.Text(title=u'Specification', required=True)
date = zope.schema.Date(title=u'Date', required=True)
date_type = zope.schema.Choice(
title=u'Date Type',
vocabulary=vocabularies.get_by_name('date-types').get('vocabulary'),
required=True)
degree = zope.schema.Choice(
title=u'Degree',
vocabulary=vocabularies.get_by_name('degrees').get('vocabulary'),
description=
u'This is the degree of conformity of the resource to the implementing rules adopted under Article 7(1) of Directive 2007/2/EC or other specification.',
default="not-evaluated",
required=True)
class IResponsibleParty(IObject):
organization = zope.schema.TextLine(title=u'Organization Name',
required=True,
min_length=2)
email = z3c.schema.email.RFC822MailAddress(title=u'Email', required=True)
role = zope.schema.Choice(
title=u'Responsible Party Role',
vocabulary=vocabularies.get_by_name('party-roles').get('vocabulary'),
description=u'This is the role of the responsible organisation.',
default='pointOfContact',
required=True)
def vocabulary_get(self, name):
name = str(name)
r = None
vocab = vocabularies.get_by_name(name)
if vocab:
terms = vocab['vocabulary'].by_value
r = {
'date_type': vocab.get('date_type'),
'reference_date': vocab.get('reference_date'),
'title': vocab.get('title'),
'name': vocab.get('name'),
'terms': [{ 'value': k, 'title': terms[k].title } for k in terms],
}
response.headers['Content-Type'] = content_types['json']
return [to_json(r)]
def make(cls, name):
'''Create a new Thesaurus instance from it's machine-name name.
The metadata for this thesaurus are queried from vocabularies module.
Note: Maybe rename this class-method to lookup
'''
spec = vocabularies.get_by_name(name)
if spec:
kwargs = {
'title': spec.get('title'),
'name': spec.get('name'),
'reference_date': spec.get('reference_date'),
'version' : spec.get('version'),
'date_type': spec.get('date_type'),
}
return cls(**kwargs)
else:
raise ValueError(
'Cannot find an INSPIRE thesaurus named "%s"' %(name))
class IInspireMetadata(IBaseMetadata):
zope.interface.taggedValue('recurse-on-invariants', True)
# Metadata on metadata
contact = zope.schema.List(
title=u'Metadata Point of Contact',
description=
u'The organisations responsible for the creation and maintenance of the metadata.',
required=True,
min_length=1,
max_length=4,
value_type=zope.schema.Object(IResponsibleParty,
title=u'Contact',
required=True))
datestamp = zope.schema.Date(
title=u'Metadata Date',
description=
u"The date which specifies when the metadata record was created or updated. This date shall be expressed in conformity with ISO 8601.",
required=False,
defaultFactory=datetime.date.today)
languagecode = zope.schema.Choice(
title=u'Metadata Language',
vocabulary=vocabularies.get_by_name('languages').get('vocabulary'),
description=
u"This is the language in which the metadata elements are expressed. The value domain of this metadata element is limited to the official languages of the Community expressed in conformity with ISO 639-2.",
required=True,
default='eng')
# Identification
identtype = zope.schema.DottedName(
title=u'Type',
required=True,
default='dataset',
)
title = zope.schema.TextLine(
title=u'Resource Title',
description=
u"This a characteristic (and often unique) name by which the resource is known.",
required=True)
identifier = zope.schema.NativeStringLine(
title=u'Identifier',
description=
u"A value uniquely identifying the dataset. The value domain of this metadata element is a mandatory character string code, generally assigned by the data owner, and a character string namespace uniquely identifying the context of the identifier code (for example, the data owner).",
required=True)
abstract = zope.schema.Text(
title=u"Resource Abstract",
description=
u"This is a brief narrative summary of the contents of this dataset.",
required=True)
locator = zope.schema.List(
title=u'Resource Locator',
description=
u"The resource locator defines the link(s) to the resource and/or the link to additional information about the resource. The value domain of this metadata element is a character string, commonly expressed as uniform resource locator (URL).",
required=True,
min_length=1,
max_length=6,
value_type=zope.schema.URI(title=u'Linkage', required=True))
resource_language = zope.schema.List(
title=u'Resource Languages',
description=
u"The language(s) used within the resource. The value domain of this metadata element is limited to the languages defined in ISO 639-2.",
required=False,
max_length=5,
value_type=zope.schema.Choice(
title=u'Resource Language',
vocabulary=vocabularies.get_by_name('languages').get('vocabulary'),
))
# Classification
topic_category = zope.schema.List(
title=u'Topic Categories',
description=
u"The topic category is a high-level classification scheme to assist in the grouping and topic-based search of available spatial data resources. The value domain of this metadata element is defined in Part D.2.",
required=True,
min_length=1,
max_length=6,
value_type=zope.schema.Choice(
title=u'Topic Category',
vocabulary=vocabularies.get_by_name('topic-category').get(
'vocabulary'),
))
topic_category.setTaggedValue('format:markup',
{'descend-if-dictized': False})
# Keywords
keywords = zope.schema.Dict(
title=u'Keywords',
description=
u'The keyword value is a commonly used word, formalised word or phrase used to describe the subject. While the topic category is too coarse for detailed queries, keywords help narrowing a full text search and they allow for structured keyword search.',
required=True,
min_length=1,
key_type=zope.schema.Choice(vocabulary=SimpleVocabulary(
tuple(
SimpleTerm(k, k,
vocabularies.get_by_name(k).get('title'))
for k in keyword_thesaurus_names)),
title=u'Keyword Thesaurus'),
value_type=zope.schema.Object(IThesaurusTerms, title=u'Keywords'))
keywords.setTaggedValue('format:markup', {'descend-if-dictized': False})
@zope.interface.invariant
def check_keywords(obj):
if obj.keywords:
if not ('keywords-gemet-inspire-themes' in obj.keywords):
raise zope.interface.Invalid(
'You need to select at least one keyword from INSPIRE data themes'
)
# Geographic
bounding_box = zope.schema.List(
title=u'Geographic Bounding Box',
description=
u"This is the extent of the resource in the geographic space, given as a bounding box. The bounding box shall be expressed with westbound and eastbound longitudes, and southbound and northbound latitudes in decimal degrees, with a precision of at least two decimals.",
required=True,
min_length=1,
max_length=4,
value_type=zope.schema.Object(IGeographicBoundingBox,
title=u'Bounding Box'))
bounding_box.setTaggedValue('format:markup', {'descend-if-dictized': True})
# Temporal
temporal_extent = zope.schema.List(
title=u'Temporal Extents',
description=
u"The temporal extent defines the time period covered by the content of the resource. This time period may be expressed as any of the following: - an individual date, - an interval of dates expressed through the starting date and end date of the interval,- a mix of individual dates and intervals of dates.",
required=False,
max_length=3,
value_type=zope.schema.Object(ITemporalExtent, title=u'Extent'))
creation_date = zope.schema.Date(
title=u'Creation Date',
description=
u"This is the date of creation of the resource. There shall not be more than one date of creation.",
required=False)
publication_date = zope.schema.Date(
title=u'Publication Date',
description=
u"This is the date of publication of the resource when available, or the date of entry into force. There may be more than one date of publication.",
required=False)
revision_date = zope.schema.Date(
title=u'Revision Date',
description=
u"This is the date of last revision of the resource, if the resource has been revised. There shall not be more than one date of last revision.",
required=False)
@zope.interface.invariant
def check_creation_publication_order(obj):
errs = []
if obj.creation_date and obj.publication_date:
if obj.creation_date > obj.publication_date:
errs.append(
'Creation date (%s) is later than publication date (%s)' %
(obj.creation_date, obj.publication_date))
if obj.publication_date and obj.revision_date:
if obj.publication_date > obj.revision_date:
errs.append(
'Publication date (%s) is later than last revision date (%s)'
% (obj.publication_date, obj.revision_date))
if obj.creation_date and obj.revision_date:
if obj.creation_date > obj.revision_date:
errs.append(
'Creation date (%s) is later than last revision date (%s)'
% (obj.creation_date, obj.revision_date))
if errs:
raise zope.interface.Invalid(errs)
# Quality & Validity
lineage = zope.schema.Text(
title=u'Lineage',
description=
u"This is a statement on process history and/or overall quality of the spatial data set. Where appropriate it may include a statement whether the data set has been validated or quality assured, whether it is the official version (if multiple versions exist), and whether it has legal validity. The value domain of this metadata element is free text.",
required=False)
spatial_resolution = zope.schema.List(
title=u'Spatial Resolution',
description=
u'''Spatial resolution refers to the level of detail of the data set. It shall be expressed as a set of zero to many resolution distances (typically for gridded data and imagery-derived products) or equivalent scales (typically for maps or map-derived products). An equivalent scale is generally expressed as an integer value expressing the scale denominator. A resolution distance shall be expressed as a numerical value associated with a unit of length.''',
required=False,
max_length=6,
value_type=zope.schema.Object(ISpatialResolution, title=u'Resolution'))
spatial_resolution.value_type.setTaggedValue('allow-partial-update', False)
# Conformity
conformity = zope.schema.List(title=u'Conformity',
required=False,
max_length=4,
value_type=zope.schema.Object(
IConformity, title=u'Specification'))
# Constraints
# Todo: The following fields should have suggestions (autocompleted?) values.
access_constraints = zope.schema.List(
title=u'Access Constraints',
description=
u'Define the conditions for access and use of spatial data sets and services, and where applicable, corresponding fees as required by Article 5(2)(b) and Article 11(2)(f) of Directive 2007/2/EC. The value domain of this metadata element is free text. The element must have values. If no conditions apply to the access and use of the resource, "no conditions apply" shall be used. If conditions are unknown, "conditions unknown" shall be used. This element shall also provide information on any fees necessary to access and use the resource, if applicable, or refer to a uniform resource locator (URL) where information on fees is available.',
required=True,
min_length=1,
max_length=4,
value_type=zope.schema.TextLine(title=u'Condition'))
limitations = zope.schema.List(
title=u'Limitations',
description=
u"When member states limit public access to spatial data sets and spatial data services under Article 13 of Directive 2007/2/EC, this metadata element shall provide information on the limitations and the reasons for them. If there are no limitations on public access, this metadata element shall indicate that fact. The value domain of this metadata element is free text.",
required=True,
min_length=1,
max_length=4,
value_type=zope.schema.TextLine(title=u'Limitation'))
# Responsible Party
responsible_party = zope.schema.List(
title=u'Responsible Party',
description=
u'The responsible party names the organisation responsible for the establishment, management, maintenance and distribution of resources contained in this dataset.',
required=True,
min_length=1,
max_length=3,
value_type=zope.schema.Object(IResponsibleParty, title=u'Party'))
def vocabulary(self):
spec = vocabularies.get_by_name(self.name)
return spec.get('vocabulary') if spec else None