eulfedora.xml - Fedora XML objects (for REST API returns)

Currently, this module consists of XmlObject wrappers for the XML returned by the REST API, to simplify dealing with results.

class eulfedora.xml.DatastreamProfile(node=None, context=None, **kwargs)

XmlObject for datastream profile information returned by REST_API.getDatastream().

checksum

checksum for current datastream contents

checksum_type

type of checksum

control_group

datastream control group (inline XML, Managed, etc)

created

date the datastream was created

format

format URI for the datastream, if any

label

datastream label

mimetype

datastream mimetype

size

integer; size of the datastream content

state

datastream state (A/I/D - Active, Inactive, Deleted)

version_id

current datastream version id

versionable

boolean; indicates whether or not the datastream is currently being versioned

class eulfedora.xml.DsCompositeModel(node=None, context=None, **kwargs)

XmlObject for a ContentModel‘s DS-COMPOSITE-MODEL datastream

class eulfedora.xml.FedoraDateField(xpath)

Map an XPath expression to a single Python datetime.datetime. Assumes date-time format in use by Fedora, e.g. 2010-05-20T18:42:52.766Z

class eulfedora.xml.FedoraDateListField(xpath)

Map an XPath expression to a list of Python datetime.datetime. Assumes date-time format in use by Fedora, e.g. 2010-05-20T18:42:52.766Z. If the XPath expression evaluates to an empty NodeList, evaluates to an empty list.

class eulfedora.xml.NewPids(node=None, context=None, **kwargs)

XmlObject for a list of pids as returned by REST_API.getNextPID().

class eulfedora.xml.ObjectDatastream(node=None, context=None, **kwargs)

XmlObject for a single datastream as returned by REST_API.listDatastreams()

dsid

datastream id - @dsid

label

datastream label - @label

mimeType

datastream mime type - @mimeType

class eulfedora.xml.ObjectDatastreams(node=None, context=None, **kwargs)

XmlObject for the list of a single object’s datastreams, as returned by REST_API.listDatastreams()

datastreams

list of ObjectDatastream

pid

object pid - @pid

class eulfedora.xml.ObjectHistory(node=None, context=None, **kwargs)

XmlObject for object history information returned by REST_API.getObjectHistory().

class eulfedora.xml.ObjectMethodService(node=None, context=None, **kwargs)

XmlObject for object method services; included in ObjectMethods for data returned by REST_API.listMethods().

class eulfedora.xml.ObjectMethods(node=None, context=None, **kwargs)

XmlObject for object method information returned by REST_API.listMethods().

class eulfedora.xml.ObjectProfile(node=None, context=None, **kwargs)

XmlObject for object profile information returned by REST_API.getObjectProfile().

created

date the object was created

label

object label

modified

date the object was last modified

owner

object owner

state

object state (A/I/D - Active, Inactive, Deleted)

class eulfedora.xml.RepositoryDescription(node=None, context=None, **kwargs)

XmlObject for a repository description as returned by API_A_LITE.describeRepository()

access_url

sample access url

admin_email

administrator emails

base_url

base url

name

repository name

oai_info

RepositoryDescriptionOAI - configuration info for OAI

oai_url

sample OAI url

pid_info

RepositoryDescriptionPid - configuration info for pids

search_url

sample search url

version

version of Fedora being run

class eulfedora.xml.RepositoryDescriptionOAI(node=None, context=None, **kwargs)

XmlObject for OAI section of RepositoryDescription

delimiter

OAI delimiter

namespace

OAI namespace

sample

sample OAI id

class eulfedora.xml.RepositoryDescriptionPid(node=None, context=None, **kwargs)

XmlObject for PID section of RepositoryDescription

delimiter

PID delimiter

namespace

PID namespace

retain_pids

list of pid namespaces configured to be retained

sample

sample PID

class eulfedora.xml.SearchResult(node=None, context=None, **kwargs)

XmlObject for a single entry in the results returned by REST_API.findObjects()

pid

pid

class eulfedora.xml.SearchResults(node=None, context=None, **kwargs)

XmlObject for the results returned by REST_API.findObjects()

cursor

session cursor

expiration_date

session experation date

results

search results - list of SearchResult

session_token

session token