zope.dublincore API¶
Dublin Core interfaces
- interface zope.dublincore.interfaces.IDublinCoreElementItem[source]¶
A qualified dublin core element
- qualification¶
Qualification
The element qualification
- Implementation:
zope.schema.TextLine- Read Only:
False
- Required:
True
- Default Value:
None
- Allowed Type:
- interface zope.dublincore.interfaces.IGeneralDublinCore[source]¶
Dublin-core data access interface
The Dublin Core, http://dublincore.org/, is a meta data standard that specifies a set of standard data elements. It provides flexibility of interpretation of these elements by providing for element qualifiers that specialize the meaning of specific elements. For example, a date element might have a qualifier, like “creation” to indicate that the date is a creation date. In addition, any element may be repeated. For some elements, like subject, and contributor, this is obviously necessary, but for other elements, like title and description, allowing repetitions is not very useful and adds complexity.
This interface provides methods for retrieving data in full generality, to be compliant with the Dublin Core standard. Other interfaces will provide more convenient access methods tailored to specific element usage patterns.
- getQualifiedContributors()¶
Return a sequence of Contributor IDublinCoreElementItem.
- getQualifiedCoverages()¶
Return a sequence of Coverage IDublinCoreElementItem.
- getQualifiedCreators()¶
Return a sequence of Creator IDublinCoreElementItem.
- getQualifiedDates()¶
Return a sequence of Date IDublinCoreElementItem.
- getQualifiedDescriptions()¶
Return a sequence of Description IDublinCoreElementItem.
- getQualifiedFormats()¶
Return a sequence of Format IDublinCoreElementItem.
- getQualifiedIdentifiers()¶
Return a sequence of Identifier IDublinCoreElementItem.
- getQualifiedLanguages()¶
Return a sequence of Language IDublinCoreElementItem.
- getQualifiedPublishers()¶
Return a sequence of Publisher IDublinCoreElementItem.
- getQualifiedRelations()¶
Return a sequence of Relation IDublinCoreElementItem.
- getQualifiedRights()¶
Return a sequence of Rights IDublinCoreElementItem.
- getQualifiedSources()¶
Return a sequence of Source IDublinCoreElementItem.
- getQualifiedSubjects()¶
Return a sequence of Subject IDublinCoreElementItem.
- getQualifiedTitles()¶
Return a sequence of Title IDublinCoreElementItem.
- getQualifiedTypes()¶
Return a sequence of Type IDublinCoreElementItem.
- interface zope.dublincore.interfaces.IWritableGeneralDublinCore[source]¶
Provide write access to dublin core data
This interface augments IStandardDublinCore with methods for writing elements.
- setQualifiedContributors(qualified_contributors)¶
Set the qualified Contributors elements.
The argument must be a sequence of Contributor IDublinCoreElementItem.
- setQualifiedCoverages(qualified_coverages)¶
Set the qualified Coverages elements.
The argument must be a sequence of Coverage IDublinCoreElementItem.
- setQualifiedCreators(qualified_creators)¶
Set the qualified Creator elements.
The argument must be a sequence of Creator IDublinCoreElementItem.
- setQualifiedDates(qualified_dates)¶
Set the qualified Dates elements.
The argument must be a sequence of Date IDublinCoreElementItem.
- setQualifiedDescriptions(qualified_descriptions)¶
Set the qualified Descriptions elements.
The argument must be a sequence of Description IDublinCoreElementItem.
- setQualifiedFormats(qualified_formats)¶
Set the qualified Formats elements.
The argument must be a sequence of Format IDublinCoreElementItem.
- setQualifiedIdentifiers(qualified_identifiers)¶
Set the qualified Identifiers elements.
The argument must be a sequence of Identifier IDublinCoreElementItem.
- setQualifiedLanguages(qualified_languages)¶
Set the qualified Languages elements.
The argument must be a sequence of Language IDublinCoreElementItem.
- setQualifiedPublishers(qualified_publishers)¶
Set the qualified Publishers elements.
The argument must be a sequence of Publisher IDublinCoreElementItem.
- setQualifiedRelations(qualified_relations)¶
Set the qualified Relations elements.
The argument must be a sequence of Relation IDublinCoreElementItem.
- setQualifiedRights(qualified_rights)¶
Set the qualified Rights elements.
The argument must be a sequence of Rights IDublinCoreElementItem.
- setQualifiedSources(qualified_sources)¶
Set the qualified Sources elements.
The argument must be a sequence of Source IDublinCoreElementItem.
- setQualifiedSubjects(qualified_subjects)¶
Set the qualified Subjects elements.
The argument must be a sequence of Subject IDublinCoreElementItem.
- setQualifiedTitles(qualified_titles)¶
Set the qualified Title elements.
The argument must be a sequence of IDublinCoreElementItem.
- setQualifiedTypes(qualified_types)¶
Set the qualified Types elements.
The argument must be a sequence of Type IDublinCoreElementItem.
- interface zope.dublincore.interfaces.IDCDescriptiveProperties[source]¶
Basic descriptive meta-data properties
- description¶
Description
The first unqualified Dublin Core ‘Description’ element value.
- Implementation:
zope.schema.Text- Read Only:
False
- Required:
True
- Default Value:
None
- Allowed Type:
- interface zope.dublincore.interfaces.IDCTimes[source]¶
Time properties
- created¶
Creation Date
The date and time that an object is created. This is normally set automatically.
- Implementation:
zope.schema.Datetime- Read Only:
False
- Required:
True
- Default Value:
None
- Allowed Type:
- modified¶
Modification Date
The date and time that the object was last modified in a meaningful way.
- Implementation:
zope.schema.Datetime- Read Only:
False
- Required:
True
- Default Value:
None
- Allowed Type:
- interface zope.dublincore.interfaces.IDCPublishing[source]¶
Publishing properties
- effective¶
Effective Date
The date and time that an object should be published.
- Implementation:
zope.schema.Datetime- Read Only:
False
- Required:
True
- Default Value:
None
- Allowed Type:
- expires¶
Expiration Date
The date and time that the object should become unpublished.
- Implementation:
zope.schema.Datetime- Read Only:
False
- Required:
True
- Default Value:
None
- Allowed Type:
- interface zope.dublincore.interfaces.IDCExtended[source]¶
Extended properties
This is a mixed bag of properties we want but that we probably haven’t quite figured out yet.
- contributors¶
Contributors
The unqualified Dublin Core ‘Contributor’ element values
- Implementation:
zope.schema.Tuple- Read Only:
False
- Required:
True
- Default Value:
None
- Allowed Type:
Value Type
- Implementation:
zope.schema.TextLine- Read Only:
False
- Required:
True
- Default Value:
None
- Allowed Type:
- creators¶
Creators
The unqualified Dublin Core ‘Creator’ element values
- Implementation:
zope.schema.Tuple- Read Only:
False
- Required:
True
- Default Value:
None
- Allowed Type:
Value Type
- Implementation:
zope.schema.TextLine- Read Only:
False
- Required:
True
- Default Value:
None
- Allowed Type:
- publisher¶
Publisher
The first unqualified Dublin Core ‘Publisher’ element value.
- Implementation:
zope.schema.Text- Read Only:
False
- Required:
True
- Default Value:
None
- Allowed Type:
- interface zope.dublincore.interfaces.ICMFDublinCore[source]¶
This interface duplicates the CMF dublin core interface.
- Contributors()¶
Return the resource contributors
Return any additional collaborators.
The unqualified Dublin Core Contributor element values are returned as a sequence of unicode strings.
- CreationDate()¶
Return the creation date.
The value of the first Dublin Core Date element qualified by ‘creation’ is returned as a unicode string if a qualified element is defined, otherwise, an empty unicode string is returned. The string is formatted ‘YYYY-MM-DD H24:MN:SS TZ’.
- Creator()¶
Return the resource creators.
Return the full name(s) of the author(s) of the content object.
The unqualified Dublin Core Creator element values are returned as a sequence of unicode strings.
- Date()¶
Return the default date
The first unqualified Dublin Core Date element value is returned as a unicode string if an unqualified element is defined, otherwise, an empty unicode string is returned. The string is formatted ‘YYYY-MM-DD H24:MN:SS TZ’.
- Description()¶
Return the resource description
Return a natural language description of this object.
The first unqualified Dublin Core Description element value is returned as a unicode string if an unqualified element is defined, otherwise, an empty unicode string is returned.
- EffectiveDate()¶
Return the effective date
The value of the first Dublin Core Date element qualified by ‘effective’ is returned as a unicode string if a qualified element is defined, otherwise, an empty unicode string is returned. The string is formatted ‘YYYY-MM-DD H24:MN:SS TZ’.
- ExpirationDate()¶
Date resource expires.
The value of the first Dublin Core Date element qualified by ‘expiration’ is returned as a unicode string if a qualified element is defined, otherwise, an empty unicode string is returned. The string is formatted ‘YYYY-MM-DD H24:MN:SS TZ’.
- Format()¶
Return the resource format.
Return the resource’s MIME type (e.g., ‘text/html’, ‘image/png’, etc.).
The first unqualified Dublin Core Format element value is returned as a unicode string if an unqualified element is defined, otherwise, an empty unicode string is returned.
- Identifier()¶
Return the URL of the resource.
This value is computed. It is included in the output of qualifiedIdentifiers with the qualification ‘url’.
- Language()¶
Return the resource language.
Return the RFC language code (e.g., ‘en-US’, ‘pt-BR’) for the resource.
The first unqualified Dublin Core Language element value is returned as a unicode string if an unqualified element is defined, otherwise, an empty unicode string is returned.
- ModificationDate()¶
Date resource last modified.
The value of the first Dublin Core Date element qualified by ‘modification’ is returned as a unicode string if a qualified element is defined, otherwise, an empty unicode string is returned. The string is formatted ‘YYYY-MM-DD H24:MN:SS TZ’.
- Publisher()¶
Dublin Core element - resource publisher
Return full formal name of the entity or person responsible for publishing the resource.
The first unqualified Dublin Core Publisher element value is returned as a unicode string if an unqualified element is defined, otherwise, an empty unicode string is returned.
- Rights()¶
Return the resource rights.
Return a string describing the intellectual property status, if any, of the resource. for the resource.
The first unqualified Dublin Core Rights element value is returned as a unicode string if an unqualified element is defined, otherwise, an empty unicode string is returned.
- Subject()¶
Return the resource subjects.
The unqualified Dublin Core Subject element values are returned as a sequence of unicode strings.
- Title()¶
Return the resource title.
The first unqualified Dublin Core Title element value is returned as a unicode string if an unqualified element is defined, otherwise, an empty unicode string is returned.
- Type()¶
Return the resource type
Return a human-readable type name for the resource.
The first unqualified Dublin Core Type element value is returned as a unicode string if an unqualified element is defined, otherwise, an empty unicode string is returned.
- interface zope.dublincore.interfaces.IZopeDublinCore[source]¶
Extends:
zope.dublincore.interfaces.IGeneralDublinCore,zope.dublincore.interfaces.ICMFDublinCore,zope.dublincore.interfaces.IDCDescriptiveProperties,zope.dublincore.interfaces.IDCTimes,zope.dublincore.interfaces.IDCPublishing,zope.dublincore.interfaces.IDCExtendedZope Dublin Core properties
- interface zope.dublincore.interfaces.IWriteZopeDublinCore[source]¶
Extends:
zope.dublincore.interfaces.IZopeDublinCore,zope.dublincore.interfaces.IWritableGeneralDublinCoreZope Dublin Core properties with generate update support