| Version: | 0.3-4 | 
| Date: | 2025-09-01 | 
| Title: | Tools to Handle and Publish Metadata as 'Atom' XML Format | 
| Maintainer: | Emmanuel Blondel <emmanuel.blondel1@gmail.com> | 
| Depends: | R (≥ 3.3), methods | 
| Imports: | R6, jsonlite, readr, XML, httr, zip, rdflib, keyring | 
| Suggests: | testthat | 
| Description: | Provides tools to read/write/publish metadata based on the 'Atom' XML syndication format. This includes support of 'Dublin Core' XML implementation, and a client to API(s) implementing the 'AtomPub' - 'SWORD' API specification. | 
| License: | MIT + file LICENSE | 
| URL: | https://github.com/eblondel/atom4R | 
| BugReports: | https://github.com/eblondel/atom4R/issues | 
| RoxygenNote: | 7.3.2 | 
| NeedsCompilation: | no | 
| Packaged: | 2025-09-01 08:01:54 UTC; emman | 
| Author: | Emmanuel Blondel | 
| Repository: | CRAN | 
| Date/Publication: | 2025-09-01 10:10:08 UTC | 
Tools to Handle and Publish Metadata as Atom XML Format
Description
Provides tools to read/write/publish metadata based on the Atom XML syndication format. This includes support of Dublin Core XML implementation, and a client to APIs implementing the AtomPub SWORD API specification.
Author(s)
Emmanuel Blondel emmanuel.blondel1@gmail.com
See Also
Useful links:
Atom feed class
Description
This class models an atom abstract object
Format
 R6Class object.
Details
AtomAbstractObject
Value
Object of  R6Class for modelling an Atom abstract Object
Super class
atom4R::atom4RLogger -> AtomAbstractObject
Public fields
- wrap
- wrapping XML element 
- element
- element 
- namespace
- namespace 
- defaults
- defaults 
- attrs
- attrs 
- printAttrs
- attrs to print 
- parentAttrs
- parent attrs 
Methods
Public methods
Inherited methods
Method new()
Initializes an object of class AtomAbstractObject
Usage
AtomAbstractObject$new( xml = NULL, element = NULL, namespace = NULL, attrs = list(), defaults = list(), wrap = TRUE, logger = "INFO" )
Arguments
- xml
- object of class XMLInternalNode-class 
- element
- element 
- namespace
- namespace 
- attrs
- attrs 
- defaults
- defaults 
- wrap
- wrap 
- logger
- logger type 
Method setIsDocument()
Set if object is a document or not
Usage
AtomAbstractObject$setIsDocument(isDocument)
Arguments
- isDocument
- object of class - logical
Method isDocument()
Informs if the object is a document
Usage
AtomAbstractObject$isDocument()
Returns
object of class logical
Method getRootElement()
Get root XML element
Usage
AtomAbstractObject$getRootElement()
Returns
object of class character
Method getNamespace()
Get XML namespace
Usage
AtomAbstractObject$getNamespace()
Returns
object of class character
Method createElement()
Creates an element
Usage
AtomAbstractObject$createElement(element, type = "text")
Arguments
- element
- element 
- type
- type. Default is "text" 
Returns
the typed element
Method addListElement()
Add a metadata element to an element list
Usage
AtomAbstractObject$addListElement(field, metadataElement)
Arguments
- field
- field 
- metadataElement
- metadata element to add 
Returns
TRUE if added, FALSE otherwise
Method delListElement()
Deletes a metadata element from an element list
Usage
AtomAbstractObject$delListElement(field, metadataElement)
Arguments
- field
- field 
- metadataElement
- metadata element to add 
Returns
TRUE if deleted, FALSE otherwise
Method contains()
Indicates if an element list contains or not an element
Usage
AtomAbstractObject$contains(field, metadataElement)
Arguments
- field
- field 
- metadataElement
- metadata element to add 
Returns
TRUE if contained, FALSE otherwise
Method print()
Prints the element
Usage
AtomAbstractObject$print(..., depth = 1)
Arguments
- ...
- any parameter to pass to print method 
- depth
- printing depth 
Method decode()
Decodes the object from an XML representation
Usage
AtomAbstractObject$decode(xml)
Arguments
- xml
- object of class XMLInternalNode-class from XML 
Method encode()
Encodes the object as XML
Usage
AtomAbstractObject$encode( addNS = TRUE, validate = TRUE, strict = FALSE, encoding = "UTF-8" )
Arguments
- addNS
- whether namespace has to be added. Default is - TRUE
- validate
- whether validation has to be done vs. XML schemas. Default is - TRUE
- strict
- whether strict validation has to be operated (raise an error if invalid). Default is - FALSE
- encoding
- encoding. Default is "UTF-8" 
Method validate()
Validates the object / XML vs. XML schemas
Usage
AtomAbstractObject$validate(xml = NULL, strict = FALSE)
Arguments
- xml
- object of class XMLInternalNode-class from XML 
- strict
- strict validation or not 
Returns
TRUE if valid, FALSE otherwise
Method save()
Saves the object as XML file
Usage
AtomAbstractObject$save(file, ...)
Arguments
- file
- file name 
- ...
- any parameter to pass to - encode()method
Method isFieldInheritedFrom()
Indicates the class from which field is inherited
Usage
AtomAbstractObject$isFieldInheritedFrom(field)
Arguments
- field
- field 
Returns
an object of class  R6Class, or NULL
Method getClassName()
Get class name
Usage
AtomAbstractObject$getClassName()
Returns
object of class character
Method getClass()
Get class
Usage
AtomAbstractObject$getClass()
Returns
object of class R6Class
Method getNamespaceDefinition()
Get namespace definition
Usage
AtomAbstractObject$getNamespaceDefinition(recursive = FALSE)
Arguments
- recursive
- recursive 
Returns
a named list of the XML namespaces
Method getXmlElement()
Get XML element name
Usage
AtomAbstractObject$getXmlElement()
Returns
object of class character
Method clone()
The objects of this class are cloneable with this method.
Usage
AtomAbstractObject$clone(deep = FALSE)
Arguments
- deep
- Whether to make a deep clone. 
Note
abstract class used internally by atom4R
Author(s)
Emmanuel Blondel <emmanuel.blondel1@gmail.com>
Atom Author class
Description
This class models an Atom Author
Format
 R6Class object.
Details
AtomAuthor
Value
Object of  R6Class for modelling an Atom Author
Super classes
atom4R::atom4RLogger -> atom4R::AtomAbstractObject -> atom4R::AtomPerson -> AtomAuthor
Methods
Public methods
Inherited methods
- atom4R::atom4RLogger$ERROR()
- atom4R::atom4RLogger$INFO()
- atom4R::atom4RLogger$WARN()
- atom4R::atom4RLogger$logger()
- atom4R::AtomAbstractObject$addListElement()
- atom4R::AtomAbstractObject$contains()
- atom4R::AtomAbstractObject$createElement()
- atom4R::AtomAbstractObject$decode()
- atom4R::AtomAbstractObject$delListElement()
- atom4R::AtomAbstractObject$encode()
- atom4R::AtomAbstractObject$getClass()
- atom4R::AtomAbstractObject$getClassName()
- atom4R::AtomAbstractObject$getNamespace()
- atom4R::AtomAbstractObject$getNamespaceDefinition()
- atom4R::AtomAbstractObject$getRootElement()
- atom4R::AtomAbstractObject$getXmlElement()
- atom4R::AtomAbstractObject$isDocument()
- atom4R::AtomAbstractObject$isFieldInheritedFrom()
- atom4R::AtomAbstractObject$print()
- atom4R::AtomAbstractObject$save()
- atom4R::AtomAbstractObject$setIsDocument()
- atom4R::AtomAbstractObject$validate()
- atom4R::AtomPerson$setEmail()
- atom4R::AtomPerson$setName()
- atom4R::AtomPerson$setUri()
Method new()
Initializes an AtomAuthor
Usage
AtomAuthor$new(xml = NULL, name = NULL, uri = NULL, email = NULL)
Arguments
- xml
- object of class XMLInternalNode-class from XML 
- name
- name 
- uri
- uri 
- email
- email 
Method clone()
The objects of this class are cloneable with this method.
Usage
AtomAuthor$clone(deep = FALSE)
Arguments
- deep
- Whether to make a deep clone. 
Author(s)
Emmanuel Blondel <emmanuel.blondel1@gmail.com>
Examples
## Not run: 
  author <- AtomAuthor$new(name = "John Doe", email = "john.doe@atom4R.com")
## End(Not run)
Atom Category class
Description
This class models an atom Category
Format
R6Class object.
Details
AtomCategory
Value
Object of R6Class for modelling an Atom Category
Super classes
atom4R::atom4RLogger -> atom4R::AtomAbstractObject -> AtomCategory
Public fields
- attrs
- attrs 
- value
- value 
Methods
Public methods
Inherited methods
- atom4R::atom4RLogger$ERROR()
- atom4R::atom4RLogger$INFO()
- atom4R::atom4RLogger$WARN()
- atom4R::atom4RLogger$logger()
- atom4R::AtomAbstractObject$addListElement()
- atom4R::AtomAbstractObject$contains()
- atom4R::AtomAbstractObject$createElement()
- atom4R::AtomAbstractObject$decode()
- atom4R::AtomAbstractObject$delListElement()
- atom4R::AtomAbstractObject$encode()
- atom4R::AtomAbstractObject$getClass()
- atom4R::AtomAbstractObject$getClassName()
- atom4R::AtomAbstractObject$getNamespace()
- atom4R::AtomAbstractObject$getNamespaceDefinition()
- atom4R::AtomAbstractObject$getRootElement()
- atom4R::AtomAbstractObject$getXmlElement()
- atom4R::AtomAbstractObject$isDocument()
- atom4R::AtomAbstractObject$isFieldInheritedFrom()
- atom4R::AtomAbstractObject$print()
- atom4R::AtomAbstractObject$save()
- atom4R::AtomAbstractObject$setIsDocument()
- atom4R::AtomAbstractObject$validate()
Method new()
Initializes an AtomCategory
Usage
AtomCategory$new( xml = NULL, value = NULL, term = NULL, scheme = NULL, label = NULL )
Arguments
- xml
- object of class XMLInternalNode-class from XML 
- value
- value 
- term
- term 
- scheme
- scheme 
- label
- label 
Method setTerm()
Set term
Usage
AtomCategory$setTerm(term)
Arguments
- term
- term 
Method setScheme()
Set scheme
Usage
AtomCategory$setScheme(scheme)
Arguments
- scheme
- scheme 
Method setLabel()
Set label
Usage
AtomCategory$setLabel(label)
Arguments
- label
- label 
Method clone()
The objects of this class are cloneable with this method.
Usage
AtomCategory$clone(deep = FALSE)
Arguments
- deep
- Whether to make a deep clone. 
Author(s)
Emmanuel Blondel <emmanuel.blondel1@gmail.com>
Atom Contributorr class
Description
This class models an Atom Contributor
Format
 R6Class object.
Details
AtomContributor
Value
Object of  R6Class for modelling an Atom Contributor
Super classes
atom4R::atom4RLogger -> atom4R::AtomAbstractObject -> atom4R::AtomPerson -> AtomContributor
Methods
Public methods
Inherited methods
- atom4R::atom4RLogger$ERROR()
- atom4R::atom4RLogger$INFO()
- atom4R::atom4RLogger$WARN()
- atom4R::atom4RLogger$logger()
- atom4R::AtomAbstractObject$addListElement()
- atom4R::AtomAbstractObject$contains()
- atom4R::AtomAbstractObject$createElement()
- atom4R::AtomAbstractObject$decode()
- atom4R::AtomAbstractObject$delListElement()
- atom4R::AtomAbstractObject$encode()
- atom4R::AtomAbstractObject$getClass()
- atom4R::AtomAbstractObject$getClassName()
- atom4R::AtomAbstractObject$getNamespace()
- atom4R::AtomAbstractObject$getNamespaceDefinition()
- atom4R::AtomAbstractObject$getRootElement()
- atom4R::AtomAbstractObject$getXmlElement()
- atom4R::AtomAbstractObject$isDocument()
- atom4R::AtomAbstractObject$isFieldInheritedFrom()
- atom4R::AtomAbstractObject$print()
- atom4R::AtomAbstractObject$save()
- atom4R::AtomAbstractObject$setIsDocument()
- atom4R::AtomAbstractObject$validate()
- atom4R::AtomPerson$setEmail()
- atom4R::AtomPerson$setName()
- atom4R::AtomPerson$setUri()
Method new()
Initializes an AtomContributor
Usage
AtomContributor$new(xml = NULL, name = NULL, uri = NULL, email = NULL)
Arguments
- xml
- object of class XMLInternalNode-class from XML 
- name
- name 
- uri
- uri 
- email
- email 
Method clone()
The objects of this class are cloneable with this method.
Usage
AtomContributor$clone(deep = FALSE)
Arguments
- deep
- Whether to make a deep clone. 
Author(s)
Emmanuel Blondel <emmanuel.blondel1@gmail.com>
Examples
## Not run: 
  contrib <- AtomContributor$new(name = "John Doe", email = "john.doe@atom4R.com")
## End(Not run)
Atom Entry class
Description
This class models an atom Entry
Format
 R6Class object.
Details
AtomEntry
Value
Object of  R6Class for modelling an Atom Entry
Super classes
atom4R::atom4RLogger -> atom4R::AtomAbstractObject -> AtomEntry
Public fields
- id
- identifier 
- updated
- Update date/time 
- published
- Publication date/time 
- title
- Title 
- summary
- Summary 
- rights
- Rights 
- source
- Source 
- author
- Author(s) 
- contributor
- Contributor(s) 
- category
- Category 
- content
- Content 
Methods
Public methods
Inherited methods
- atom4R::atom4RLogger$ERROR()
- atom4R::atom4RLogger$INFO()
- atom4R::atom4RLogger$WARN()
- atom4R::atom4RLogger$logger()
- atom4R::AtomAbstractObject$addListElement()
- atom4R::AtomAbstractObject$contains()
- atom4R::AtomAbstractObject$createElement()
- atom4R::AtomAbstractObject$decode()
- atom4R::AtomAbstractObject$delListElement()
- atom4R::AtomAbstractObject$encode()
- atom4R::AtomAbstractObject$getClass()
- atom4R::AtomAbstractObject$getClassName()
- atom4R::AtomAbstractObject$getNamespace()
- atom4R::AtomAbstractObject$getNamespaceDefinition()
- atom4R::AtomAbstractObject$getRootElement()
- atom4R::AtomAbstractObject$getXmlElement()
- atom4R::AtomAbstractObject$isDocument()
- atom4R::AtomAbstractObject$isFieldInheritedFrom()
- atom4R::AtomAbstractObject$print()
- atom4R::AtomAbstractObject$save()
- atom4R::AtomAbstractObject$setIsDocument()
- atom4R::AtomAbstractObject$validate()
Method new()
Initializes an AtomEntry
Usage
AtomEntry$new(xml = NULL)
Arguments
- xml
- object of class XMLInternalNode-class from XML 
Method setId()
Set ID
Usage
AtomEntry$setId(id)
Arguments
- id
- id 
Method setUpdated()
Set updated date
Usage
AtomEntry$setUpdated(updated)
Arguments
- updated
- object of class - Dateor- POSIXt
Method setPublished()
Set published date
Usage
AtomEntry$setPublished(published)
Arguments
- published
- object of class - Dateor- POSIXt
Method setTitle()
Set title
Usage
AtomEntry$setTitle(title, type = "text")
Arguments
- title
- title 
- type
- type. Default is "text" 
Method setSummary()
Set summary
Usage
AtomEntry$setSummary(summary, type = "text")
Arguments
- summary
- summary 
- type
- type. Default is "text" 
Method setRights()
Set rights
Usage
AtomEntry$setRights(rights, type = "text")
Arguments
- rights
- rights 
- type
- type. Default is "text" 
Method setSource()
Set source
Usage
AtomEntry$setSource(source, type = "text")
Arguments
- source
- source 
- type
- type. Default is "text" 
Method addAuthor()
Adds author
Usage
AtomEntry$addAuthor(author)
Arguments
- author
- object of class AtomAuthor 
Returns
TRUE if added, FALSE otherwise
Method delAuthor()
Deletes author
Usage
AtomEntry$delAuthor(author)
Arguments
- author
- object of class AtomAuthor 
Returns
TRUE if deleted, FALSE otherwise
Method addContributor()
Adds contributor
Usage
AtomEntry$addContributor(contributor)
Arguments
- contributor
- object of class AtomContributor 
Returns
TRUE if added, FALSE otherwise
Method delContributor()
Deletes contributor
Usage
AtomEntry$delContributor(contributor)
Arguments
- contributor
- object of class AtomContributor 
Returns
TRUE if deleted, FALSE otherwise
Method addCategory()
Adds category
Usage
AtomEntry$addCategory(value, term, scheme = NULL, label = NULL)
Arguments
- value
- value 
- term
- term 
- scheme
- scheme 
- label
- label 
Returns
TRUE if added, FALSE otherwise
Method delCategory()
Deletes category
Usage
AtomEntry$delCategory(value, term, scheme = NULL, label = NULL)
Arguments
- value
- value 
- term
- term 
- scheme
- scheme 
- label
- label 
Returns
TRUE if deleted, FALSE otherwise
Method addLink()
Adds link
Usage
AtomEntry$addLink(link, rel = "alternate", type = "text/html")
Arguments
- link
- link 
- rel
- relation. Default is "alternate" 
- type
- type. Default is "text/html" 
Returns
TRUE if added, FALSE otherwise
Method delLink()
Deletes link
Usage
AtomEntry$delLink(link, rel = "alternate", type = "text/html")
Arguments
- link
- link 
- rel
- relation. Default is "alternate" 
- type
- type. Default is "text/html" 
Returns
TRUE if deleted, FALSE otherwise
Method setContent()
Set content
Usage
AtomEntry$setContent(content)
Arguments
- content
- content 
Method clone()
The objects of this class are cloneable with this method.
Usage
AtomEntry$clone(deep = FALSE)
Arguments
- deep
- Whether to make a deep clone. 
Author(s)
Emmanuel Blondel <emmanuel.blondel1@gmail.com>
Examples
 ## Not run: 
  #encoding
  atom <- AtomEntry$new()
  atom$setId("my-atom-entry")
  atom$setTitle("My Atom feed entry")
  atom$setSummary("My Atom feed entry very comprehensive abstract")
  author1 <- AtomAuthor$new(
    name = "John Doe",
    uri = "http://www.atomxml.com/johndoe",
    email = "johndoe@atom4R.com"
  )
  atom$addAuthor(author1)
  author2 <- AtomAuthor$new(
    name = "John Doe's sister",
    uri = "http://www.atomxml.com/johndoesister",
    email = "johndoesister@atom4R.com"
  )
  atom$addAuthor(author2)
  contrib1 <- AtomContributor$new(
    name = "Contrib1",
    uri = "http://www.atomxml.com/contrib1",
    email = "contrib1@atom4R.com"
  )
  atom$addContributor(contrib1)
  contrib2 <- AtomContributor$new(
    name = "Contrib2",
    uri = "http://www.atomxml.com/contrib2",
    email = "contrib2@atom4R.com"
  )
  atom$addContributor(contrib2)
  atom$addCategory("draft", "dataset")
  atom$addCategory("world", "spatial")
  atom$addCategory("fisheries", "domain")
  xml <- atom$encode()
 
## End(Not run)
Atom feed class
Description
This class models an atom feed
Format
 R6Class object.
Details
AtomFeed
Value
Object of  R6Class for modelling an Atom feed
Methods
- new(xml)
- 
This method is used to create an Atom Feed 
- setId(id)
- 
Set identifier 
- setUpdated(updated)
- 
Set update date (object of class 'character' or 'POSIX') 
- addLink(link, rel, type)
- 
Adds a link. Default relvalue is set to "alternate". Defaulttypevalue is set to "text/html"
- delLink(link, rel, type)
- 
Deletes a link 
- setSelfLink(link)
- 
Sets a self-relation link 
- setAlternateLink(link, type)
- 
Sets an alternate-relation link. Default type is "text/html" 
- setTitle(title)
- 
Set title 
- setSubtitle(subtitle)
- 
Set subtitle 
- addAuthor(author)
- 
Adds an author, object of class AtomAuthor
- delAuthor(author)
- 
Deletes an author, object of class AtomAuthor
- addContributor(contributor)
- 
Adds a contributor, object of class AtomContributor
- delContributor(contributor)
- 
Deletes a contributor, object of class AtomContributor
- setGenerator(generator, type)
- 
Sets generator 
- setIcon(icon)
- 
Sets icon 
- addCategory(term, scheme, label)
- 
Adds a category 
- delCategory(term, scheme, label)
- 
Deletes a category 
- addEntry(entry)
- 
Adds an entry, object of class AtomEntry
- delEntry(entry)
- 
Deletes an entry, object of class AtomEntry
Super classes
atom4R::atom4RLogger -> atom4R::AtomAbstractObject -> AtomFeed
Public fields
- id
- Identifier 
- updated
- Update date 
- published
- Publication date 
- title
- Title 
- subtitle
- Subtitle 
- rights
- Rights (license, use, ...) 
- author
- Author person 
- contributor
- Contributor person 
- generator
- Generator 
- icon
- Icon 
- logo
- Logo 
- category
- Category 
- link
- links 
- entry
- List of entries 
Methods
Public methods
Inherited methods
- atom4R::atom4RLogger$ERROR()
- atom4R::atom4RLogger$INFO()
- atom4R::atom4RLogger$WARN()
- atom4R::atom4RLogger$logger()
- atom4R::AtomAbstractObject$addListElement()
- atom4R::AtomAbstractObject$contains()
- atom4R::AtomAbstractObject$createElement()
- atom4R::AtomAbstractObject$decode()
- atom4R::AtomAbstractObject$delListElement()
- atom4R::AtomAbstractObject$encode()
- atom4R::AtomAbstractObject$getClass()
- atom4R::AtomAbstractObject$getClassName()
- atom4R::AtomAbstractObject$getNamespace()
- atom4R::AtomAbstractObject$getNamespaceDefinition()
- atom4R::AtomAbstractObject$getRootElement()
- atom4R::AtomAbstractObject$getXmlElement()
- atom4R::AtomAbstractObject$isDocument()
- atom4R::AtomAbstractObject$isFieldInheritedFrom()
- atom4R::AtomAbstractObject$print()
- atom4R::AtomAbstractObject$save()
- atom4R::AtomAbstractObject$setIsDocument()
- atom4R::AtomAbstractObject$validate()
Method new()
Initializes a AtomFeed
Usage
AtomFeed$new(xml = NULL)
Arguments
- xml
- object of class XMLInternalNode-class from XML 
Method setId()
Set ID
Usage
AtomFeed$setId(id)
Arguments
- id
- id 
Method setUpdated()
Set updated date
Usage
AtomFeed$setUpdated(updated)
Arguments
- updated
- object of class - Dateor- POSIXt
Method setPublished()
Set published date
Usage
AtomFeed$setPublished(published)
Arguments
- published
- object of class - Dateor- POSIXt
Method addLink()
Adds link
Usage
AtomFeed$addLink(link, rel = "alternate", type = "text/html")
Arguments
- link
- link 
- rel
- relation. Default is "alternate" 
- type
- type. Default is "text/html" 
Returns
TRUE if added, FALSE otherwise
Method delLink()
Deletes link
Usage
AtomFeed$delLink(link, rel = "alternate", type = "text/html")
Arguments
- link
- link 
- rel
- relation. Default is "alternate" 
- type
- type. Default is "text/html" 
Returns
TRUE if deleted, FALSE otherwise
Method setSelfLink()
Set self link
Usage
AtomFeed$setSelfLink(link)
Arguments
- link
- link 
Returns
TRUE if set, FALSE otherwise
Method setAlternateLink()
Set alternate link
Usage
AtomFeed$setAlternateLink(link, type = "text/html")
Arguments
- link
- link 
- type
- type. Default is "text/html" 
Returns
TRUE if set, FALSE otherwise
Method setTitle()
Set title
Usage
AtomFeed$setTitle(title, type = "text")
Arguments
- title
- title 
- type
- type. Default is "text" 
Method setSubtitle()
Set subtitle
Usage
AtomFeed$setSubtitle(subtitle, type = "text")
Arguments
- subtitle
- subtitle 
- type
- type. Default is "text" 
Method setRights()
Set rights
Usage
AtomFeed$setRights(rights, type = "text")
Arguments
- rights
- rights 
- type
- type. Default is "text" 
Method addAuthor()
Adds author
Usage
AtomFeed$addAuthor(author)
Arguments
- author
- object of class AtomAuthor 
Returns
TRUE if added, FALSE otherwise
Method delAuthor()
Deletes author
Usage
AtomFeed$delAuthor(author)
Arguments
- author
- object of class AtomAuthor 
Returns
TRUE if deleted, FALSE otherwise
Method addContributor()
Adds contributor
Usage
AtomFeed$addContributor(contributor)
Arguments
- contributor
- object of class AtomContributor 
Returns
TRUE if added, FALSE otherwise
Method delContributor()
Deletes contributor
Usage
AtomFeed$delContributor(contributor)
Arguments
- contributor
- object of class AtomContributor 
Returns
TRUE if deleted, FALSE otherwise
Method setGenerator()
Set generator
Usage
AtomFeed$setGenerator(generator, type = "text")
Arguments
- generator
- generator 
- type
- type. Default is "text" 
Method setIcon()
Set icon
Usage
AtomFeed$setIcon(icon)
Arguments
- icon
- icon 
Method addCategory()
Adds category
Usage
AtomFeed$addCategory(value, term, scheme = NULL, label = NULL)
Arguments
- value
- value 
- term
- term 
- scheme
- scheme 
- label
- label 
Returns
TRUE if added, FALSE otherwise
Method delCategory()
Deletes category
Usage
AtomFeed$delCategory(value, term, scheme = NULL, label = NULL)
Arguments
- value
- value 
- term
- term 
- scheme
- scheme 
- label
- label 
Returns
TRUE if deleted, FALSE otherwise
Method addEntry()
Adds an entry
Usage
AtomFeed$addEntry(entry)
Arguments
- entry
- object of class AtomEntry 
Returns
TRUE if added, FALSE otherwise
Method delEntry()
Deletes an entry
Usage
AtomFeed$delEntry(entry)
Arguments
- entry
- object of class AtomEntry 
Returns
TRUE if deleted, FALSE otherwise
Method clone()
The objects of this class are cloneable with this method.
Usage
AtomFeed$clone(deep = FALSE)
Arguments
- deep
- Whether to make a deep clone. 
Author(s)
Emmanuel Blondel <emmanuel.blondel1@gmail.com>
Examples
  #encoding
  atom <- AtomFeed$new()
  atom$setId("my-atom-feed")
  atom$setTitle("My Atom feed title")
  atom$setSubtitle("MyAtom feed subtitle")
  author1 <- AtomAuthor$new(
    name = "John Doe",
    uri = "http://www.atomxml.com/johndoe",
    email = "johndoe@atom4R.com"
  )
  atom$addAuthor(author1)
  author2 <- AtomAuthor$new(
    name = "John Doe's sister",
    uri = "http://www.atomxml.com/johndoesister",
    email = "johndoesister@atom4R.com"
  )
  atom$addAuthor(author2)
  contrib1 <- AtomContributor$new(
    name = "Contrib1",
    uri = "http://www.atomxml.com/contrib1",
    email = "contrib1@atom4R.com"
  )
  atom$addContributor(contrib1)
  contrib2 <- AtomContributor$new(
    name = "Contrib2",
    uri = "http://www.atomxml.com/contrib2",
    email = "contrib2@atom4R.com"
  )
  atom$addContributor(contrib2)
  atom$setIcon("https://via.placeholder.com/300x150.png/03f/fff?text=atom4R")
  atom$setSelfLink("http://example.com/atom.feed")
  atom$setAlternateLink("http://example.com/my-atom-feed")
  atom$addCategory("draft", "dataset")
  atom$addCategory("world", "spatial")
  atom$addCategory("fisheries", "domain")
  #add entry
  entry <- AtomEntry$new()
  entry$setId("my-atom-entry")
  entry$setTitle("My Atom feed entry")
  entry$setSummary("My Atom feed entry very comprehensive abstract")
  author1 <- AtomAuthor$new(
    name = "John Doe",
    uri = "http://www.atomxml.com/johndoe",
    email = "johndoe@atom4R.com"
  )
  entry$addAuthor(author1)
  author2 <- AtomAuthor$new(
    name = "John Doe's sister",
    uri = "http://www.atomxml.com/johndoesister",
    email = "johndoesister@atom4R.com"
  )
  entry$addAuthor(author2)
  contrib1 <- AtomContributor$new(
    name = "Contrib1",
    uri = "http://www.atomxml.com/contrib1",
    email = "contrib1@atom4R.com"
  )
  entry$addContributor(contrib1)
  contrib2 <- AtomContributor$new(
    name = "Contrib2",
    uri = "http://www.atomxml.com/contrib2",
    email = "contrib2@atom4R.com"
  )
  entry$addContributor(contrib2)
  entry$addCategory("draft", "dataset")
  entry$addCategory("world", "spatial")
  entry$addCategory("fisheries", "domain")
  atom$addEntry(entry)
  xml <- atom$encode()
Atom Link class
Description
This class models an atom Link
Format
 R6Class object.
Details
AtomLink
Value
Object of  R6Class for modelling an Atom Link
Super classes
atom4R::atom4RLogger -> atom4R::AtomAbstractObject -> AtomLink
Public fields
- attrs
- attrs 
Methods
Public methods
Inherited methods
- atom4R::atom4RLogger$ERROR()
- atom4R::atom4RLogger$INFO()
- atom4R::atom4RLogger$WARN()
- atom4R::atom4RLogger$logger()
- atom4R::AtomAbstractObject$addListElement()
- atom4R::AtomAbstractObject$contains()
- atom4R::AtomAbstractObject$createElement()
- atom4R::AtomAbstractObject$decode()
- atom4R::AtomAbstractObject$delListElement()
- atom4R::AtomAbstractObject$encode()
- atom4R::AtomAbstractObject$getClass()
- atom4R::AtomAbstractObject$getClassName()
- atom4R::AtomAbstractObject$getNamespace()
- atom4R::AtomAbstractObject$getNamespaceDefinition()
- atom4R::AtomAbstractObject$getRootElement()
- atom4R::AtomAbstractObject$getXmlElement()
- atom4R::AtomAbstractObject$isDocument()
- atom4R::AtomAbstractObject$isFieldInheritedFrom()
- atom4R::AtomAbstractObject$print()
- atom4R::AtomAbstractObject$save()
- atom4R::AtomAbstractObject$setIsDocument()
- atom4R::AtomAbstractObject$validate()
Method new()
Initializes an AtomLink
Usage
AtomLink$new( xml = NULL, rel = NULL, type = NULL, href = NULL, hreflang = NULL, title = NULL, length = NULL )
Arguments
- xml
- object of class XMLInternalNode-class from XML 
- rel
- rel 
- type
- type 
- href
- href 
- hreflang
- hreflang 
- title
- title 
- length
- length 
Method setRel()
Set relation
Usage
AtomLink$setRel(rel)
Arguments
- rel
- rel 
Method setType()
Set type
Usage
AtomLink$setType(type)
Arguments
- type
- type 
Method setHref()
Set href
Usage
AtomLink$setHref(href)
Arguments
- href
- href 
Method setHreflang()
Set href lang
Usage
AtomLink$setHreflang(hreflang)
Arguments
- hreflang
- hreflang 
Method setTitle()
Set title
Usage
AtomLink$setTitle(title)
Arguments
- title
- title 
Method setLength()
Set length
Usage
AtomLink$setLength(length)
Arguments
- length
- length 
Method clone()
The objects of this class are cloneable with this method.
Usage
AtomLink$clone(deep = FALSE)
Arguments
- deep
- Whether to make a deep clone. 
Author(s)
Emmanuel Blondel <emmanuel.blondel1@gmail.com>
AtomNamespace
Description
AtomNamespace
AtomNamespace
Format
 R6Class object.
Value
Object of  R6Class for modelling an Atom Namespace
Public fields
- id
- id 
- uri
- uri 
Methods
Public methods
Method new()
Initializes an AtomNamespace
Usage
AtomNamespace$new(id, uri)
Arguments
- id
- id 
- uri
- uri 
Method getDefinition()
Get definition
Usage
AtomNamespace$getDefinition()
Returns
a named list defining the namespace
Method clone()
The objects of this class are cloneable with this method.
Usage
AtomNamespace$clone(deep = FALSE)
Arguments
- deep
- Whether to make a deep clone. 
Note
ISO class used internally by atom4R for specifying XML namespaces
Author(s)
Emmanuel Blondel <emmanuel.blondel1@gmail.com>
Atom Person class
Description
This class models an Atom Person
Format
 R6Class object.
Details
AtomPerson
Value
Object of  R6Class for modelling an Atom Person
Super classes
atom4R::atom4RLogger -> atom4R::AtomAbstractObject -> AtomPerson
Public fields
- name
- name 
- uri
- uri 
- email
- email 
Methods
Public methods
Inherited methods
- atom4R::atom4RLogger$ERROR()
- atom4R::atom4RLogger$INFO()
- atom4R::atom4RLogger$WARN()
- atom4R::atom4RLogger$logger()
- atom4R::AtomAbstractObject$addListElement()
- atom4R::AtomAbstractObject$contains()
- atom4R::AtomAbstractObject$createElement()
- atom4R::AtomAbstractObject$decode()
- atom4R::AtomAbstractObject$delListElement()
- atom4R::AtomAbstractObject$encode()
- atom4R::AtomAbstractObject$getClass()
- atom4R::AtomAbstractObject$getClassName()
- atom4R::AtomAbstractObject$getNamespace()
- atom4R::AtomAbstractObject$getNamespaceDefinition()
- atom4R::AtomAbstractObject$getRootElement()
- atom4R::AtomAbstractObject$getXmlElement()
- atom4R::AtomAbstractObject$isDocument()
- atom4R::AtomAbstractObject$isFieldInheritedFrom()
- atom4R::AtomAbstractObject$print()
- atom4R::AtomAbstractObject$save()
- atom4R::AtomAbstractObject$setIsDocument()
- atom4R::AtomAbstractObject$validate()
Method new()
Initializes an AtomPerson
Usage
AtomPerson$new(xml = NULL, name = NULL, uri = NULL, email = NULL)
Arguments
- xml
- object of class XMLInternalNode-class from XML 
- name
- name 
- uri
- uri 
- email
- email 
Method setName()
Set name
Usage
AtomPerson$setName(name)
Arguments
- name
- name 
Method setUri()
Set URI
Usage
AtomPerson$setUri(uri)
Arguments
- uri
- uri 
Method setEmail()
Set email
Usage
AtomPerson$setEmail(email)
Arguments
- email
- email 
Method clone()
The objects of this class are cloneable with this method.
Usage
AtomPerson$clone(deep = FALSE)
Arguments
- deep
- Whether to make a deep clone. 
Note
Abstract class used internally for person-like classes
Author(s)
Emmanuel Blondel <emmanuel.blondel1@gmail.com>
AtomPubClient class
Description
This class models an AtomPub service client
Format
 R6Class object.
Details
AtomPubClient
Value
Object of  R6Class for modelling an AtomPub client
Methods
- new(url, user, pwd, token, keyring_backend)
- 
This method is to instantiate an AtomPub Client. The keyring_backendcan be set to use a different backend for storing the Atom pub user token with keyring (Default value is 'env').The logger can be either NULL, "INFO" (with minimum logs), or "DEBUG" (for complete curl http calls logs) 
- getUser()
- 
Retrieves user (if any specified). 
- getPwd()
- 
Retrieves user password (if any user specified). 
- getToken()
- 
Retrieves user token. 
- getServiceDocument()
- 
Gets service document description. Unimplemented in abstract classes. 
- listCollections(pretty)
- 
Lists the available collections. Use prettyto return a "data.frame" insteaf of a list.
- getCollectionMembers(collectionId)
- 
List members of a collection. Unimplemented in abstract classes. 
Super class
atom4R::atom4RLogger -> AtomPubClient
Public fields
- service
- service 
Methods
Public methods
Inherited methods
Method new()
This method is to instantiate an Sword Client. By default the version is set to "2".
The keyring_backend can be set to use a different backend for storing
the SWORD API user token with keyring (Default value is 'env').
The logger allows to specify the level of log (default is NULL), either "INFO"
for atom4R logs or "DEBUG" for verbose HTTP client (curl) logs.
Usage
AtomPubClient$new( url, user = NULL, pwd = NULL, token = NULL, logger = NULL, keyring_backend = "env" )
Arguments
- url
- url 
- user
- user 
- pwd
- pwd 
- token
- token 
- logger
- logger 
- keyring_backend
- keyring backend. Default is 'env' 
Method getUser()
Get user
Usage
AtomPubClient$getUser()
Returns
object of class character
Method getPwd()
Get password
Usage
AtomPubClient$getPwd()
Returns
object of class character
Method getToken()
Get token
Usage
AtomPubClient$getToken()
Returns
object of class character
Method getServiceDocument()
Get service document
Usage
AtomPubClient$getServiceDocument()
Arguments
- force
- force Force getting/refreshing of service document 
Returns
object of class SwordServiceDocument
Method listCollections()
List collections
Usage
AtomPubClient$listCollections(pretty = FALSE)
Arguments
- pretty
- pretty 
Returns
a list of collections, or data.frame
Method getCollectionMembers()
Get collection members. Unimplemented abstract method at AtomPubClient level
Usage
AtomPubClient$getCollectionMembers()
Method clone()
The objects of this class are cloneable with this method.
Usage
AtomPubClient$clone(deep = FALSE)
Arguments
- deep
- Whether to make a deep clone. 
Note
Abstract class used internally for AtomPub (Atom Publishing Protocol) clients
Author(s)
Emmanuel Blondel <emmanuel.blondel1@gmail.com>
DCAbstract
Description
This class models an DublinCore 'abstract' element
Format
 R6Class object.
Value
Object of  R6Class for modelling an Dublin Core 'abstract' element
Super classes
atom4R::atom4RLogger -> atom4R::AtomAbstractObject -> atom4R::DCElement -> atom4R::DCDescription -> DCAbstract
Methods
Public methods
Inherited methods
- atom4R::atom4RLogger$ERROR()
- atom4R::atom4RLogger$INFO()
- atom4R::atom4RLogger$WARN()
- atom4R::atom4RLogger$logger()
- atom4R::AtomAbstractObject$addListElement()
- atom4R::AtomAbstractObject$contains()
- atom4R::AtomAbstractObject$createElement()
- atom4R::AtomAbstractObject$decode()
- atom4R::AtomAbstractObject$delListElement()
- atom4R::AtomAbstractObject$encode()
- atom4R::AtomAbstractObject$getClass()
- atom4R::AtomAbstractObject$getClassName()
- atom4R::AtomAbstractObject$getNamespace()
- atom4R::AtomAbstractObject$getNamespaceDefinition()
- atom4R::AtomAbstractObject$getRootElement()
- atom4R::AtomAbstractObject$getXmlElement()
- atom4R::AtomAbstractObject$isDocument()
- atom4R::AtomAbstractObject$isFieldInheritedFrom()
- atom4R::AtomAbstractObject$print()
- atom4R::AtomAbstractObject$save()
- atom4R::AtomAbstractObject$setIsDocument()
- atom4R::AtomAbstractObject$validate()
Method new()
Initializes an object of class DCAbstract
Usage
DCAbstract$new(xml = NULL, value = NULL)
Arguments
- xml
- object of class XMLInternalNode-class from XML 
- value
- value 
Method clone()
The objects of this class are cloneable with this method.
Usage
DCAbstract$clone(deep = FALSE)
Arguments
- deep
- Whether to make a deep clone. 
References
Dublin Core Metadata Initiative. https://www.dublincore.org/specifications/dublin-core/dcmi-terms/terms/abstract
DCAccessRights
Description
This class models an DublinCore 'accessRights' element
Format
 R6Class object.
Value
Object of  R6Class for modelling an Dublin Core 'accessRights' element
Super classes
atom4R::atom4RLogger -> atom4R::AtomAbstractObject -> atom4R::DCElement -> atom4R::DCRights -> DCAccessRights
Methods
Public methods
Inherited methods
- atom4R::atom4RLogger$ERROR()
- atom4R::atom4RLogger$INFO()
- atom4R::atom4RLogger$WARN()
- atom4R::atom4RLogger$logger()
- atom4R::AtomAbstractObject$addListElement()
- atom4R::AtomAbstractObject$contains()
- atom4R::AtomAbstractObject$createElement()
- atom4R::AtomAbstractObject$decode()
- atom4R::AtomAbstractObject$delListElement()
- atom4R::AtomAbstractObject$encode()
- atom4R::AtomAbstractObject$getClass()
- atom4R::AtomAbstractObject$getClassName()
- atom4R::AtomAbstractObject$getNamespace()
- atom4R::AtomAbstractObject$getNamespaceDefinition()
- atom4R::AtomAbstractObject$getRootElement()
- atom4R::AtomAbstractObject$getXmlElement()
- atom4R::AtomAbstractObject$isDocument()
- atom4R::AtomAbstractObject$isFieldInheritedFrom()
- atom4R::AtomAbstractObject$print()
- atom4R::AtomAbstractObject$save()
- atom4R::AtomAbstractObject$setIsDocument()
- atom4R::AtomAbstractObject$validate()
Method new()
Initializes an object of class DCAccessRights
Usage
DCAccessRights$new(xml = NULL, value = NULL)
Arguments
- xml
- object of class XMLInternalNode-class from XML 
- value
- value 
Method clone()
The objects of this class are cloneable with this method.
Usage
DCAccessRights$clone(deep = FALSE)
Arguments
- deep
- Whether to make a deep clone. 
References
Dublin Core Metadata Initiative. https://www.dublincore.org/specifications/dublin-core/dcmi-terms/terms/accessRights
DCAccrualMethod
Description
This class models an DublinCore 'accrualMethod' element
Format
 R6Class object.
Value
Object of  R6Class for modelling an Dublin Core 'accrualMethod' element
Super classes
atom4R::atom4RLogger -> atom4R::AtomAbstractObject -> atom4R::DCElement -> DCAccrualMethod
Methods
Public methods
Inherited methods
- atom4R::atom4RLogger$ERROR()
- atom4R::atom4RLogger$INFO()
- atom4R::atom4RLogger$WARN()
- atom4R::atom4RLogger$logger()
- atom4R::AtomAbstractObject$addListElement()
- atom4R::AtomAbstractObject$contains()
- atom4R::AtomAbstractObject$createElement()
- atom4R::AtomAbstractObject$decode()
- atom4R::AtomAbstractObject$delListElement()
- atom4R::AtomAbstractObject$encode()
- atom4R::AtomAbstractObject$getClass()
- atom4R::AtomAbstractObject$getClassName()
- atom4R::AtomAbstractObject$getNamespace()
- atom4R::AtomAbstractObject$getNamespaceDefinition()
- atom4R::AtomAbstractObject$getRootElement()
- atom4R::AtomAbstractObject$getXmlElement()
- atom4R::AtomAbstractObject$isDocument()
- atom4R::AtomAbstractObject$isFieldInheritedFrom()
- atom4R::AtomAbstractObject$print()
- atom4R::AtomAbstractObject$save()
- atom4R::AtomAbstractObject$setIsDocument()
- atom4R::AtomAbstractObject$validate()
Method new()
Initializes an object of class DCAccrualMethod
Usage
DCAccrualMethod$new(xml = NULL, value = NULL)
Arguments
- xml
- object of class XMLInternalNode-class from XML 
- value
- value 
Method clone()
The objects of this class are cloneable with this method.
Usage
DCAccrualMethod$clone(deep = FALSE)
Arguments
- deep
- Whether to make a deep clone. 
References
Dublin Core Metadata Initiative. https://www.dublincore.org/specifications/dublin-core/dcmi-terms/terms/accrualMethod
DCAccrualPeriodicity
Description
This class models an DublinCore 'accrualPeriodicity' element
Format
 R6Class object.
Value
Object of  R6Class for modelling an Dublin Core 'accrualPeriodicity' element
Super classes
atom4R::atom4RLogger -> atom4R::AtomAbstractObject -> atom4R::DCElement -> DCAccrualPeriodicity
Methods
Public methods
Inherited methods
- atom4R::atom4RLogger$ERROR()
- atom4R::atom4RLogger$INFO()
- atom4R::atom4RLogger$WARN()
- atom4R::atom4RLogger$logger()
- atom4R::AtomAbstractObject$addListElement()
- atom4R::AtomAbstractObject$contains()
- atom4R::AtomAbstractObject$createElement()
- atom4R::AtomAbstractObject$decode()
- atom4R::AtomAbstractObject$delListElement()
- atom4R::AtomAbstractObject$encode()
- atom4R::AtomAbstractObject$getClass()
- atom4R::AtomAbstractObject$getClassName()
- atom4R::AtomAbstractObject$getNamespace()
- atom4R::AtomAbstractObject$getNamespaceDefinition()
- atom4R::AtomAbstractObject$getRootElement()
- atom4R::AtomAbstractObject$getXmlElement()
- atom4R::AtomAbstractObject$isDocument()
- atom4R::AtomAbstractObject$isFieldInheritedFrom()
- atom4R::AtomAbstractObject$print()
- atom4R::AtomAbstractObject$save()
- atom4R::AtomAbstractObject$setIsDocument()
- atom4R::AtomAbstractObject$validate()
Method new()
Initializes an object of class DCAccrualPeriodicity
Usage
DCAccrualPeriodicity$new(xml = NULL, value = NULL)
Arguments
- xml
- object of class XMLInternalNode-class from XML 
- value
- value 
Method clone()
The objects of this class are cloneable with this method.
Usage
DCAccrualPeriodicity$clone(deep = FALSE)
Arguments
- deep
- Whether to make a deep clone. 
References
Dublin Core Metadata Initiative. https://www.dublincore.org/specifications/dublin-core/dcmi-terms/terms/accrualPeriodicity
DCAccrualPolicy
Description
This class models an DublinCore 'accrualPolicy' element
Format
 R6Class object.
Value
Object of  R6Class for modelling an Dublin Core 'accrualPolicy' element
Super classes
atom4R::atom4RLogger -> atom4R::AtomAbstractObject -> atom4R::DCElement -> DCAccrualPolicy
Methods
Public methods
Inherited methods
- atom4R::atom4RLogger$ERROR()
- atom4R::atom4RLogger$INFO()
- atom4R::atom4RLogger$WARN()
- atom4R::atom4RLogger$logger()
- atom4R::AtomAbstractObject$addListElement()
- atom4R::AtomAbstractObject$contains()
- atom4R::AtomAbstractObject$createElement()
- atom4R::AtomAbstractObject$decode()
- atom4R::AtomAbstractObject$delListElement()
- atom4R::AtomAbstractObject$encode()
- atom4R::AtomAbstractObject$getClass()
- atom4R::AtomAbstractObject$getClassName()
- atom4R::AtomAbstractObject$getNamespace()
- atom4R::AtomAbstractObject$getNamespaceDefinition()
- atom4R::AtomAbstractObject$getRootElement()
- atom4R::AtomAbstractObject$getXmlElement()
- atom4R::AtomAbstractObject$isDocument()
- atom4R::AtomAbstractObject$isFieldInheritedFrom()
- atom4R::AtomAbstractObject$print()
- atom4R::AtomAbstractObject$save()
- atom4R::AtomAbstractObject$setIsDocument()
- atom4R::AtomAbstractObject$validate()
Method new()
Initializes an object of class DCAccrualPolicy
Usage
DCAccrualPolicy$new(xml = NULL, value = NULL)
Arguments
- xml
- object of class XMLInternalNode-class from XML 
- value
- value 
Method clone()
The objects of this class are cloneable with this method.
Usage
DCAccrualPolicy$clone(deep = FALSE)
Arguments
- deep
- Whether to make a deep clone. 
References
Dublin Core Metadata Initiative. https://www.dublincore.org/specifications/dublin-core/dcmi-terms/terms/accrualPolicy
DCAlternative
Description
This class models an DublinCore 'alternative' element
Format
 R6Class object.
Value
Object of  R6Class for modelling an Dublin Core 'alternative' element
Super classes
atom4R::atom4RLogger -> atom4R::AtomAbstractObject -> atom4R::DCElement -> atom4R::DCTitle -> DCAlternative
Methods
Public methods
Inherited methods
- atom4R::atom4RLogger$ERROR()
- atom4R::atom4RLogger$INFO()
- atom4R::atom4RLogger$WARN()
- atom4R::atom4RLogger$logger()
- atom4R::AtomAbstractObject$addListElement()
- atom4R::AtomAbstractObject$contains()
- atom4R::AtomAbstractObject$createElement()
- atom4R::AtomAbstractObject$decode()
- atom4R::AtomAbstractObject$delListElement()
- atom4R::AtomAbstractObject$encode()
- atom4R::AtomAbstractObject$getClass()
- atom4R::AtomAbstractObject$getClassName()
- atom4R::AtomAbstractObject$getNamespace()
- atom4R::AtomAbstractObject$getNamespaceDefinition()
- atom4R::AtomAbstractObject$getRootElement()
- atom4R::AtomAbstractObject$getXmlElement()
- atom4R::AtomAbstractObject$isDocument()
- atom4R::AtomAbstractObject$isFieldInheritedFrom()
- atom4R::AtomAbstractObject$print()
- atom4R::AtomAbstractObject$save()
- atom4R::AtomAbstractObject$setIsDocument()
- atom4R::AtomAbstractObject$validate()
Method new()
Initializes an object of class DCAlternative
Usage
DCAlternative$new(xml = NULL, value = NULL)
Arguments
- xml
- object of class XMLInternalNode-class from XML 
- value
- value 
Method clone()
The objects of this class are cloneable with this method.
Usage
DCAlternative$clone(deep = FALSE)
Arguments
- deep
- Whether to make a deep clone. 
References
Dublin Core Metadata Initiative. https://www.dublincore.org/specifications/dublin-core/dcmi-terms/terms/alternative
DCAudience
Description
This class models an DublinCore 'audience' element
Format
 R6Class object.
Value
Object of  R6Class for modelling an Dublin Core 'audience' element
Super classes
atom4R::atom4RLogger -> atom4R::AtomAbstractObject -> atom4R::DCElement -> DCAudience
Methods
Public methods
Inherited methods
- atom4R::atom4RLogger$ERROR()
- atom4R::atom4RLogger$INFO()
- atom4R::atom4RLogger$WARN()
- atom4R::atom4RLogger$logger()
- atom4R::AtomAbstractObject$addListElement()
- atom4R::AtomAbstractObject$contains()
- atom4R::AtomAbstractObject$createElement()
- atom4R::AtomAbstractObject$decode()
- atom4R::AtomAbstractObject$delListElement()
- atom4R::AtomAbstractObject$encode()
- atom4R::AtomAbstractObject$getClass()
- atom4R::AtomAbstractObject$getClassName()
- atom4R::AtomAbstractObject$getNamespace()
- atom4R::AtomAbstractObject$getNamespaceDefinition()
- atom4R::AtomAbstractObject$getRootElement()
- atom4R::AtomAbstractObject$getXmlElement()
- atom4R::AtomAbstractObject$isDocument()
- atom4R::AtomAbstractObject$isFieldInheritedFrom()
- atom4R::AtomAbstractObject$print()
- atom4R::AtomAbstractObject$save()
- atom4R::AtomAbstractObject$setIsDocument()
- atom4R::AtomAbstractObject$validate()
Method new()
Initializes an object of class DCAudience
Usage
DCAudience$new(xml = NULL, term = NULL, value = NULL)
Arguments
- xml
- object of class XMLInternalNode-class from XML 
- term
- term 
- value
- value 
Method clone()
The objects of this class are cloneable with this method.
Usage
DCAudience$clone(deep = FALSE)
Arguments
- deep
- Whether to make a deep clone. 
References
Dublin Core Metadata Initiative. https://www.dublincore.org/specifications/dublin-core/dcmi-terms/terms/audience
DCAvailable
Description
This class models an DublinCore 'available' element
Format
 R6Class object.
Value
Object of  R6Class for modelling an Dublin Core 'available' element
Super classes
atom4R::atom4RLogger -> atom4R::AtomAbstractObject -> atom4R::DCElement -> atom4R::DCDate -> DCAvailable
Methods
Public methods
Inherited methods
- atom4R::atom4RLogger$ERROR()
- atom4R::atom4RLogger$INFO()
- atom4R::atom4RLogger$WARN()
- atom4R::atom4RLogger$logger()
- atom4R::AtomAbstractObject$addListElement()
- atom4R::AtomAbstractObject$contains()
- atom4R::AtomAbstractObject$createElement()
- atom4R::AtomAbstractObject$decode()
- atom4R::AtomAbstractObject$delListElement()
- atom4R::AtomAbstractObject$encode()
- atom4R::AtomAbstractObject$getClass()
- atom4R::AtomAbstractObject$getClassName()
- atom4R::AtomAbstractObject$getNamespace()
- atom4R::AtomAbstractObject$getNamespaceDefinition()
- atom4R::AtomAbstractObject$getRootElement()
- atom4R::AtomAbstractObject$getXmlElement()
- atom4R::AtomAbstractObject$isDocument()
- atom4R::AtomAbstractObject$isFieldInheritedFrom()
- atom4R::AtomAbstractObject$print()
- atom4R::AtomAbstractObject$save()
- atom4R::AtomAbstractObject$setIsDocument()
- atom4R::AtomAbstractObject$validate()
Method new()
Initializes an object of class DCAvailable
Usage
DCAvailable$new(xml = NULL, value = NULL)
Arguments
- xml
- object of class XMLInternalNode-class from XML 
- value
- value 
Method clone()
The objects of this class are cloneable with this method.
Usage
DCAvailable$clone(deep = FALSE)
Arguments
- deep
- Whether to make a deep clone. 
References
Dublin Core Metadata Initiative. https://www.dublincore.org/specifications/dublin-core/dcmi-terms/terms/available
DCBibliographicCitation
Description
This class models an DublinCore 'bibliographicCitation' element
Format
 R6Class object.
Value
Object of  R6Class for modelling an Dublin Core 'bibliographicCitation' element
Super classes
atom4R::atom4RLogger -> atom4R::AtomAbstractObject -> atom4R::DCElement -> atom4R::DCIdentifier -> DCBibliographicCitation
Methods
Public methods
Inherited methods
- atom4R::atom4RLogger$ERROR()
- atom4R::atom4RLogger$INFO()
- atom4R::atom4RLogger$WARN()
- atom4R::atom4RLogger$logger()
- atom4R::AtomAbstractObject$addListElement()
- atom4R::AtomAbstractObject$contains()
- atom4R::AtomAbstractObject$createElement()
- atom4R::AtomAbstractObject$decode()
- atom4R::AtomAbstractObject$delListElement()
- atom4R::AtomAbstractObject$encode()
- atom4R::AtomAbstractObject$getClass()
- atom4R::AtomAbstractObject$getClassName()
- atom4R::AtomAbstractObject$getNamespace()
- atom4R::AtomAbstractObject$getNamespaceDefinition()
- atom4R::AtomAbstractObject$getRootElement()
- atom4R::AtomAbstractObject$getXmlElement()
- atom4R::AtomAbstractObject$isDocument()
- atom4R::AtomAbstractObject$isFieldInheritedFrom()
- atom4R::AtomAbstractObject$print()
- atom4R::AtomAbstractObject$save()
- atom4R::AtomAbstractObject$setIsDocument()
- atom4R::AtomAbstractObject$validate()
Method new()
Initializes an object of class DCBibliographicCitation
Usage
DCBibliographicCitation$new(xml = NULL, value = NULL)
Arguments
- xml
- object of class XMLInternalNode-class from XML 
- value
- value 
Method clone()
The objects of this class are cloneable with this method.
Usage
DCBibliographicCitation$clone(deep = FALSE)
Arguments
- deep
- Whether to make a deep clone. 
References
Dublin Core Metadata Initiative. https://www.dublincore.org/specifications/dublin-core/dcmi-terms/terms/bibliographicCitation
DCConformsTo
Description
This class models an DublinCore 'conformsTo' element
Format
 R6Class object.
Value
Object of  R6Class for modelling an Dublin Core 'conformsTo' element
Super classes
atom4R::atom4RLogger -> atom4R::AtomAbstractObject -> atom4R::DCElement -> atom4R::DCRelation -> DCConformsTo
Methods
Public methods
Inherited methods
- atom4R::atom4RLogger$ERROR()
- atom4R::atom4RLogger$INFO()
- atom4R::atom4RLogger$WARN()
- atom4R::atom4RLogger$logger()
- atom4R::AtomAbstractObject$addListElement()
- atom4R::AtomAbstractObject$contains()
- atom4R::AtomAbstractObject$createElement()
- atom4R::AtomAbstractObject$decode()
- atom4R::AtomAbstractObject$delListElement()
- atom4R::AtomAbstractObject$encode()
- atom4R::AtomAbstractObject$getClass()
- atom4R::AtomAbstractObject$getClassName()
- atom4R::AtomAbstractObject$getNamespace()
- atom4R::AtomAbstractObject$getNamespaceDefinition()
- atom4R::AtomAbstractObject$getRootElement()
- atom4R::AtomAbstractObject$getXmlElement()
- atom4R::AtomAbstractObject$isDocument()
- atom4R::AtomAbstractObject$isFieldInheritedFrom()
- atom4R::AtomAbstractObject$print()
- atom4R::AtomAbstractObject$save()
- atom4R::AtomAbstractObject$setIsDocument()
- atom4R::AtomAbstractObject$validate()
Method new()
Initializes an object of class DCConformsTo
Usage
DCConformsTo$new(xml = NULL, value = NULL)
Arguments
- xml
- object of class XMLInternalNode-class from XML 
- value
- value 
Method clone()
The objects of this class are cloneable with this method.
Usage
DCConformsTo$clone(deep = FALSE)
Arguments
- deep
- Whether to make a deep clone. 
References
Dublin Core Metadata Initiative. https://www.dublincore.org/specifications/dublin-core/dcmi-terms/terms/conformsTo
DCContributor
Description
This class models an DublinCore 'contributor' element
Format
 R6Class object.
Value
Object of  R6Class for modelling an Dublin Core 'contributor' element
Super classes
atom4R::atom4RLogger -> atom4R::AtomAbstractObject -> atom4R::DCElement -> DCContributor
Methods
Public methods
Inherited methods
- atom4R::atom4RLogger$ERROR()
- atom4R::atom4RLogger$INFO()
- atom4R::atom4RLogger$WARN()
- atom4R::atom4RLogger$logger()
- atom4R::AtomAbstractObject$addListElement()
- atom4R::AtomAbstractObject$contains()
- atom4R::AtomAbstractObject$createElement()
- atom4R::AtomAbstractObject$decode()
- atom4R::AtomAbstractObject$delListElement()
- atom4R::AtomAbstractObject$encode()
- atom4R::AtomAbstractObject$getClass()
- atom4R::AtomAbstractObject$getClassName()
- atom4R::AtomAbstractObject$getNamespace()
- atom4R::AtomAbstractObject$getNamespaceDefinition()
- atom4R::AtomAbstractObject$getRootElement()
- atom4R::AtomAbstractObject$getXmlElement()
- atom4R::AtomAbstractObject$isDocument()
- atom4R::AtomAbstractObject$isFieldInheritedFrom()
- atom4R::AtomAbstractObject$print()
- atom4R::AtomAbstractObject$save()
- atom4R::AtomAbstractObject$setIsDocument()
- atom4R::AtomAbstractObject$validate()
Method new()
This method is used to create an Dublin core 'contributor' element.
Use dc to TRUE to use Dublin core namespace instead of DC terms.
Usage
DCContributor$new(xml = NULL, value = NULL, dc = FALSE)
Arguments
- xml
- object of class XMLInternalNode-class from XML 
- value
- value 
- dc
- use DC namespace? 
Method clone()
The objects of this class are cloneable with this method.
Usage
DCContributor$clone(deep = FALSE)
Arguments
- deep
- Whether to make a deep clone. 
References
Dublin Core Metadata Initiative. https://www.dublincore.org/specifications/dublin-core/dcmi-terms/terms/contributor
DCCoverage
Description
This class models an DublinCore Terms 'coverage' element
Format
 R6Class object.
Value
Object of  R6Class for modelling an Dublin Core Terms 'coverage' element
Super classes
atom4R::atom4RLogger -> atom4R::AtomAbstractObject -> atom4R::DCElement -> DCCoverage
Methods
Public methods
Inherited methods
- atom4R::atom4RLogger$ERROR()
- atom4R::atom4RLogger$INFO()
- atom4R::atom4RLogger$WARN()
- atom4R::atom4RLogger$logger()
- atom4R::AtomAbstractObject$addListElement()
- atom4R::AtomAbstractObject$contains()
- atom4R::AtomAbstractObject$createElement()
- atom4R::AtomAbstractObject$decode()
- atom4R::AtomAbstractObject$delListElement()
- atom4R::AtomAbstractObject$encode()
- atom4R::AtomAbstractObject$getClass()
- atom4R::AtomAbstractObject$getClassName()
- atom4R::AtomAbstractObject$getNamespace()
- atom4R::AtomAbstractObject$getNamespaceDefinition()
- atom4R::AtomAbstractObject$getRootElement()
- atom4R::AtomAbstractObject$getXmlElement()
- atom4R::AtomAbstractObject$isDocument()
- atom4R::AtomAbstractObject$isFieldInheritedFrom()
- atom4R::AtomAbstractObject$print()
- atom4R::AtomAbstractObject$save()
- atom4R::AtomAbstractObject$setIsDocument()
- atom4R::AtomAbstractObject$validate()
Method new()
This method is used to create an Dublin core 'coverage' element.
Use dc to TRUE to use Dublin core namespace instead of DC terms.
Usage
DCCoverage$new(xml = NULL, term = NULL, value = NULL, dc = FALSE)
Arguments
- xml
- object of class XMLInternalNode-class from XML 
- term
- term 
- value
- value 
- dc
- use DC namespace? 
Method clone()
The objects of this class are cloneable with this method.
Usage
DCCoverage$clone(deep = FALSE)
Arguments
- deep
- Whether to make a deep clone. 
References
Dublin Core Metadata Initiative. https://www.dublincore.org/specifications/dublin-core/dcmi-terms/terms/coverage
DCCreated
Description
This class models an DublinCore Terms 'date' element
Format
 R6Class object.
Value
Object of  R6Class for modelling an Dublin Core Terms 'date' element
Super classes
atom4R::atom4RLogger -> atom4R::AtomAbstractObject -> atom4R::DCElement -> atom4R::DCDate -> DCCreated
Methods
Public methods
Inherited methods
- atom4R::atom4RLogger$ERROR()
- atom4R::atom4RLogger$INFO()
- atom4R::atom4RLogger$WARN()
- atom4R::atom4RLogger$logger()
- atom4R::AtomAbstractObject$addListElement()
- atom4R::AtomAbstractObject$contains()
- atom4R::AtomAbstractObject$createElement()
- atom4R::AtomAbstractObject$decode()
- atom4R::AtomAbstractObject$delListElement()
- atom4R::AtomAbstractObject$encode()
- atom4R::AtomAbstractObject$getClass()
- atom4R::AtomAbstractObject$getClassName()
- atom4R::AtomAbstractObject$getNamespace()
- atom4R::AtomAbstractObject$getNamespaceDefinition()
- atom4R::AtomAbstractObject$getRootElement()
- atom4R::AtomAbstractObject$getXmlElement()
- atom4R::AtomAbstractObject$isDocument()
- atom4R::AtomAbstractObject$isFieldInheritedFrom()
- atom4R::AtomAbstractObject$print()
- atom4R::AtomAbstractObject$save()
- atom4R::AtomAbstractObject$setIsDocument()
- atom4R::AtomAbstractObject$validate()
Method new()
Initializes an object of class DCCreated
Usage
DCCreated$new(xml = NULL, value = NULL)
Arguments
- xml
- object of class XMLInternalNode-class from XML 
- value
- value 
Method clone()
The objects of this class are cloneable with this method.
Usage
DCCreated$clone(deep = FALSE)
Arguments
- deep
- Whether to make a deep clone. 
References
Dublin Core Metadata Initiative. https://www.dublincore.org/specifications/dublin-core/dcmi-terms/terms/created
DCCreator
Description
This class models an DublinCore 'creator' element
Format
 R6Class object.
Value
Object of  R6Class for modelling an Dublin Core 'creator' element
Super classes
atom4R::atom4RLogger -> atom4R::AtomAbstractObject -> atom4R::DCElement -> DCCreator
Methods
Public methods
Inherited methods
- atom4R::atom4RLogger$ERROR()
- atom4R::atom4RLogger$INFO()
- atom4R::atom4RLogger$WARN()
- atom4R::atom4RLogger$logger()
- atom4R::AtomAbstractObject$addListElement()
- atom4R::AtomAbstractObject$contains()
- atom4R::AtomAbstractObject$createElement()
- atom4R::AtomAbstractObject$decode()
- atom4R::AtomAbstractObject$delListElement()
- atom4R::AtomAbstractObject$encode()
- atom4R::AtomAbstractObject$getClass()
- atom4R::AtomAbstractObject$getClassName()
- atom4R::AtomAbstractObject$getNamespace()
- atom4R::AtomAbstractObject$getNamespaceDefinition()
- atom4R::AtomAbstractObject$getRootElement()
- atom4R::AtomAbstractObject$getXmlElement()
- atom4R::AtomAbstractObject$isDocument()
- atom4R::AtomAbstractObject$isFieldInheritedFrom()
- atom4R::AtomAbstractObject$print()
- atom4R::AtomAbstractObject$save()
- atom4R::AtomAbstractObject$setIsDocument()
- atom4R::AtomAbstractObject$validate()
Method new()
This method is used to create an Dublin core 'creator' element.
Use dc to TRUE to use Dublin core namespace instead of DC terms.
Usage
DCCreator$new(xml = NULL, value = NULL, dc = FALSE)
Arguments
- xml
- object of class XMLInternalNode-class from XML 
- value
- value 
- dc
- use DC namespace? 
Method clone()
The objects of this class are cloneable with this method.
Usage
DCCreator$clone(deep = FALSE)
Arguments
- deep
- Whether to make a deep clone. 
References
Dublin Core Metadata Initiative. https://www.dublincore.org/specifications/dublin-core/dcmi-terms/terms/creator
DCDate
Description
This class models an DublinCore 'date' element
Format
 R6Class object.
Value
Object of  R6Class for modelling an Dublin Core 'date' element
Super classes
atom4R::atom4RLogger -> atom4R::AtomAbstractObject -> atom4R::DCElement -> DCDate
Methods
Public methods
Inherited methods
- atom4R::atom4RLogger$ERROR()
- atom4R::atom4RLogger$INFO()
- atom4R::atom4RLogger$WARN()
- atom4R::atom4RLogger$logger()
- atom4R::AtomAbstractObject$addListElement()
- atom4R::AtomAbstractObject$contains()
- atom4R::AtomAbstractObject$createElement()
- atom4R::AtomAbstractObject$decode()
- atom4R::AtomAbstractObject$delListElement()
- atom4R::AtomAbstractObject$encode()
- atom4R::AtomAbstractObject$getClass()
- atom4R::AtomAbstractObject$getClassName()
- atom4R::AtomAbstractObject$getNamespace()
- atom4R::AtomAbstractObject$getNamespaceDefinition()
- atom4R::AtomAbstractObject$getRootElement()
- atom4R::AtomAbstractObject$getXmlElement()
- atom4R::AtomAbstractObject$isDocument()
- atom4R::AtomAbstractObject$isFieldInheritedFrom()
- atom4R::AtomAbstractObject$print()
- atom4R::AtomAbstractObject$save()
- atom4R::AtomAbstractObject$setIsDocument()
- atom4R::AtomAbstractObject$validate()
Method new()
This method is used to create an Dublin core 'date' element.
Use dc to TRUE to use Dublin core namespace instead of DC terms.
Usage
DCDate$new(xml = NULL, term = NULL, value = NULL, dc = FALSE)
Arguments
- xml
- object of class XMLInternalNode-class from XML 
- term
- term 
- value
- value 
- dc
- use DC namespace? 
Method clone()
The objects of this class are cloneable with this method.
Usage
DCDate$clone(deep = FALSE)
Arguments
- deep
- Whether to make a deep clone. 
References
Dublin Core Metadata Initiative. https://www.dublincore.org/specifications/dublin-core/dcmi-terms/terms/date
DCDateAccepted
Description
This class models an DublinCore 'dateAccepted' element
Format
 R6Class object.
Value
Object of  R6Class for modelling an Dublin Core 'dateAccepted' element
Super classes
atom4R::atom4RLogger -> atom4R::AtomAbstractObject -> atom4R::DCElement -> atom4R::DCDate -> DCDateAccepted
Methods
Public methods
Inherited methods
- atom4R::atom4RLogger$ERROR()
- atom4R::atom4RLogger$INFO()
- atom4R::atom4RLogger$WARN()
- atom4R::atom4RLogger$logger()
- atom4R::AtomAbstractObject$addListElement()
- atom4R::AtomAbstractObject$contains()
- atom4R::AtomAbstractObject$createElement()
- atom4R::AtomAbstractObject$decode()
- atom4R::AtomAbstractObject$delListElement()
- atom4R::AtomAbstractObject$encode()
- atom4R::AtomAbstractObject$getClass()
- atom4R::AtomAbstractObject$getClassName()
- atom4R::AtomAbstractObject$getNamespace()
- atom4R::AtomAbstractObject$getNamespaceDefinition()
- atom4R::AtomAbstractObject$getRootElement()
- atom4R::AtomAbstractObject$getXmlElement()
- atom4R::AtomAbstractObject$isDocument()
- atom4R::AtomAbstractObject$isFieldInheritedFrom()
- atom4R::AtomAbstractObject$print()
- atom4R::AtomAbstractObject$save()
- atom4R::AtomAbstractObject$setIsDocument()
- atom4R::AtomAbstractObject$validate()
Method new()
Initializes an object of class DCDateAccepted
Usage
DCDateAccepted$new(xml = NULL, value = NULL)
Arguments
- xml
- object of class XMLInternalNode-class from XML 
- value
- value 
Method clone()
The objects of this class are cloneable with this method.
Usage
DCDateAccepted$clone(deep = FALSE)
Arguments
- deep
- Whether to make a deep clone. 
References
Dublin Core Metadata Initiative. https://www.dublincore.org/specifications/dublin-core/dcmi-terms/terms/dateAccepted
DCDateCopyrighted
Description
This class models an DublinCore 'dateCopyrighted' element
Format
 R6Class object.
Value
Object of  R6Class for modelling an Dublin Core 'dateCopyrighted' element
Super classes
atom4R::atom4RLogger -> atom4R::AtomAbstractObject -> atom4R::DCElement -> atom4R::DCDate -> DCDateCopyrighted
Methods
Public methods
Inherited methods
- atom4R::atom4RLogger$ERROR()
- atom4R::atom4RLogger$INFO()
- atom4R::atom4RLogger$WARN()
- atom4R::atom4RLogger$logger()
- atom4R::AtomAbstractObject$addListElement()
- atom4R::AtomAbstractObject$contains()
- atom4R::AtomAbstractObject$createElement()
- atom4R::AtomAbstractObject$decode()
- atom4R::AtomAbstractObject$delListElement()
- atom4R::AtomAbstractObject$encode()
- atom4R::AtomAbstractObject$getClass()
- atom4R::AtomAbstractObject$getClassName()
- atom4R::AtomAbstractObject$getNamespace()
- atom4R::AtomAbstractObject$getNamespaceDefinition()
- atom4R::AtomAbstractObject$getRootElement()
- atom4R::AtomAbstractObject$getXmlElement()
- atom4R::AtomAbstractObject$isDocument()
- atom4R::AtomAbstractObject$isFieldInheritedFrom()
- atom4R::AtomAbstractObject$print()
- atom4R::AtomAbstractObject$save()
- atom4R::AtomAbstractObject$setIsDocument()
- atom4R::AtomAbstractObject$validate()
Method new()
Initializes an object of class DCDateCopyrighted
Usage
DCDateCopyrighted$new(xml = NULL, value = NULL)
Arguments
- xml
- object of class XMLInternalNode-class from XML 
- value
- value 
Method clone()
The objects of this class are cloneable with this method.
Usage
DCDateCopyrighted$clone(deep = FALSE)
Arguments
- deep
- Whether to make a deep clone. 
References
Dublin Core Metadata Initiative. https://www.dublincore.org/specifications/dublin-core/dcmi-terms/terms/dateCopyrighted
DCDateSubmitted
Description
This class models an DublinCore 'dateSubmitted' element
Format
 R6Class object.
Value
Object of  R6Class for modelling an Dublin Core 'dateSubmitted' element
Super classes
atom4R::atom4RLogger -> atom4R::AtomAbstractObject -> atom4R::DCElement -> atom4R::DCDate -> DCDateSubmitted
Methods
Public methods
Inherited methods
- atom4R::atom4RLogger$ERROR()
- atom4R::atom4RLogger$INFO()
- atom4R::atom4RLogger$WARN()
- atom4R::atom4RLogger$logger()
- atom4R::AtomAbstractObject$addListElement()
- atom4R::AtomAbstractObject$contains()
- atom4R::AtomAbstractObject$createElement()
- atom4R::AtomAbstractObject$decode()
- atom4R::AtomAbstractObject$delListElement()
- atom4R::AtomAbstractObject$encode()
- atom4R::AtomAbstractObject$getClass()
- atom4R::AtomAbstractObject$getClassName()
- atom4R::AtomAbstractObject$getNamespace()
- atom4R::AtomAbstractObject$getNamespaceDefinition()
- atom4R::AtomAbstractObject$getRootElement()
- atom4R::AtomAbstractObject$getXmlElement()
- atom4R::AtomAbstractObject$isDocument()
- atom4R::AtomAbstractObject$isFieldInheritedFrom()
- atom4R::AtomAbstractObject$print()
- atom4R::AtomAbstractObject$save()
- atom4R::AtomAbstractObject$setIsDocument()
- atom4R::AtomAbstractObject$validate()
Method new()
Initializes an object of class DCDateSubmitted
Usage
DCDateSubmitted$new(xml = NULL, value = NULL)
Arguments
- xml
- object of class XMLInternalNode-class from XML 
- value
- value 
Method clone()
The objects of this class are cloneable with this method.
Usage
DCDateSubmitted$clone(deep = FALSE)
Arguments
- deep
- Whether to make a deep clone. 
References
Dublin Core Metadata Initiative. https://www.dublincore.org/specifications/dublin-core/dcmi-terms/terms/dateSubmitted
DCDescription
Description
This class models an DublinCore 'description' element
Format
 R6Class object.
Value
Object of  R6Class for modelling an Dublin Core 'description' element
Super classes
atom4R::atom4RLogger -> atom4R::AtomAbstractObject -> atom4R::DCElement -> DCDescription
Methods
Public methods
Inherited methods
- atom4R::atom4RLogger$ERROR()
- atom4R::atom4RLogger$INFO()
- atom4R::atom4RLogger$WARN()
- atom4R::atom4RLogger$logger()
- atom4R::AtomAbstractObject$addListElement()
- atom4R::AtomAbstractObject$contains()
- atom4R::AtomAbstractObject$createElement()
- atom4R::AtomAbstractObject$decode()
- atom4R::AtomAbstractObject$delListElement()
- atom4R::AtomAbstractObject$encode()
- atom4R::AtomAbstractObject$getClass()
- atom4R::AtomAbstractObject$getClassName()
- atom4R::AtomAbstractObject$getNamespace()
- atom4R::AtomAbstractObject$getNamespaceDefinition()
- atom4R::AtomAbstractObject$getRootElement()
- atom4R::AtomAbstractObject$getXmlElement()
- atom4R::AtomAbstractObject$isDocument()
- atom4R::AtomAbstractObject$isFieldInheritedFrom()
- atom4R::AtomAbstractObject$print()
- atom4R::AtomAbstractObject$save()
- atom4R::AtomAbstractObject$setIsDocument()
- atom4R::AtomAbstractObject$validate()
Method new()
This method is used to create an Dublin core 'description' element.
Use dc to TRUE to use Dublin core namespace instead of DC terms.
Usage
DCDescription$new(xml = NULL, term = NULL, value = NULL, dc = FALSE)
Arguments
- xml
- object of class XMLInternalNode-class from XML 
- term
- term 
- value
- value 
- dc
- use DC namespace? 
Method clone()
The objects of this class are cloneable with this method.
Usage
DCDescription$clone(deep = FALSE)
Arguments
- deep
- Whether to make a deep clone. 
References
Dublin Core Metadata Initiative. https://www.dublincore.org/specifications/dublin-core/dcmi-terms/terms/description
DCEducationalLevel
Description
This class models an DublinCore 'educationalLevel' element
Format
 R6Class object.
Value
Object of  R6Class for modelling an Dublin Core 'educationalLevel' element
Super classes
atom4R::atom4RLogger -> atom4R::AtomAbstractObject -> atom4R::DCElement -> atom4R::DCAudience -> DCEducationalLevel
Methods
Public methods
Inherited methods
- atom4R::atom4RLogger$ERROR()
- atom4R::atom4RLogger$INFO()
- atom4R::atom4RLogger$WARN()
- atom4R::atom4RLogger$logger()
- atom4R::AtomAbstractObject$addListElement()
- atom4R::AtomAbstractObject$contains()
- atom4R::AtomAbstractObject$createElement()
- atom4R::AtomAbstractObject$decode()
- atom4R::AtomAbstractObject$delListElement()
- atom4R::AtomAbstractObject$encode()
- atom4R::AtomAbstractObject$getClass()
- atom4R::AtomAbstractObject$getClassName()
- atom4R::AtomAbstractObject$getNamespace()
- atom4R::AtomAbstractObject$getNamespaceDefinition()
- atom4R::AtomAbstractObject$getRootElement()
- atom4R::AtomAbstractObject$getXmlElement()
- atom4R::AtomAbstractObject$isDocument()
- atom4R::AtomAbstractObject$isFieldInheritedFrom()
- atom4R::AtomAbstractObject$print()
- atom4R::AtomAbstractObject$save()
- atom4R::AtomAbstractObject$setIsDocument()
- atom4R::AtomAbstractObject$validate()
Method new()
Initializes an object of class DCEducationalLevel
Usage
DCEducationalLevel$new(xml = NULL, value = NULL)
Arguments
- xml
- object of class XMLInternalNode-class from XML 
- value
- value 
Method clone()
The objects of this class are cloneable with this method.
Usage
DCEducationalLevel$clone(deep = FALSE)
Arguments
- deep
- Whether to make a deep clone. 
References
Dublin Core Metadata Initiative. https://www.dublincore.org/specifications/dublin-core/dcmi-terms/terms/educationalLevel
DublinCore element class
Description
This class models an DublinCore element
Format
 R6Class object.
Details
DCElement
Value
Object of  R6Class for modelling an Dublin Core element
Super classes
atom4R::atom4RLogger -> atom4R::AtomAbstractObject -> DCElement
Public fields
- value
- value 
Methods
Public methods
Inherited methods
- atom4R::atom4RLogger$ERROR()
- atom4R::atom4RLogger$INFO()
- atom4R::atom4RLogger$WARN()
- atom4R::atom4RLogger$logger()
- atom4R::AtomAbstractObject$addListElement()
- atom4R::AtomAbstractObject$contains()
- atom4R::AtomAbstractObject$createElement()
- atom4R::AtomAbstractObject$decode()
- atom4R::AtomAbstractObject$delListElement()
- atom4R::AtomAbstractObject$encode()
- atom4R::AtomAbstractObject$getClass()
- atom4R::AtomAbstractObject$getClassName()
- atom4R::AtomAbstractObject$getNamespace()
- atom4R::AtomAbstractObject$getNamespaceDefinition()
- atom4R::AtomAbstractObject$getRootElement()
- atom4R::AtomAbstractObject$getXmlElement()
- atom4R::AtomAbstractObject$isDocument()
- atom4R::AtomAbstractObject$isFieldInheritedFrom()
- atom4R::AtomAbstractObject$print()
- atom4R::AtomAbstractObject$save()
- atom4R::AtomAbstractObject$setIsDocument()
- atom4R::AtomAbstractObject$validate()
Method new()
Initializes an abstract DCElement
Usage
DCElement$new( xml = NULL, term = NULL, value = NULL, vocabulary = NULL, extended = FALSE )
Arguments
- xml
- object of class XMLInternalNode-class from XML 
- term
- term 
- value
- value 
- vocabulary
- vocabulary 
- extended
- extended 
Method clone()
The objects of this class are cloneable with this method.
Usage
DCElement$clone(deep = FALSE)
Arguments
- deep
- Whether to make a deep clone. 
Note
Class used internally by atom4R
Author(s)
Emmanuel Blondel <emmanuel.blondel1@gmail.com>
Dublin Core Entry class
Description
This class models an Dublin Core Entry
Format
 R6Class object.
Details
DCEntry
Value
Object of  R6Class for modelling an Dublin Core Entry
Super classes
atom4R::atom4RLogger -> atom4R::AtomAbstractObject -> atom4R::AtomEntry -> DCEntry
Methods
Public methods
Inherited methods
- atom4R::atom4RLogger$ERROR()
- atom4R::atom4RLogger$INFO()
- atom4R::atom4RLogger$WARN()
- atom4R::atom4RLogger$logger()
- atom4R::AtomAbstractObject$addListElement()
- atom4R::AtomAbstractObject$contains()
- atom4R::AtomAbstractObject$createElement()
- atom4R::AtomAbstractObject$decode()
- atom4R::AtomAbstractObject$delListElement()
- atom4R::AtomAbstractObject$encode()
- atom4R::AtomAbstractObject$getClass()
- atom4R::AtomAbstractObject$getClassName()
- atom4R::AtomAbstractObject$getNamespace()
- atom4R::AtomAbstractObject$getNamespaceDefinition()
- atom4R::AtomAbstractObject$getRootElement()
- atom4R::AtomAbstractObject$getXmlElement()
- atom4R::AtomAbstractObject$isDocument()
- atom4R::AtomAbstractObject$isFieldInheritedFrom()
- atom4R::AtomAbstractObject$print()
- atom4R::AtomAbstractObject$save()
- atom4R::AtomAbstractObject$setIsDocument()
- atom4R::AtomAbstractObject$validate()
- atom4R::AtomEntry$addAuthor()
- atom4R::AtomEntry$addCategory()
- atom4R::AtomEntry$addContributor()
- atom4R::AtomEntry$addLink()
- atom4R::AtomEntry$delAuthor()
- atom4R::AtomEntry$delCategory()
- atom4R::AtomEntry$delContributor()
- atom4R::AtomEntry$delLink()
- atom4R::AtomEntry$setContent()
- atom4R::AtomEntry$setId()
- atom4R::AtomEntry$setPublished()
- atom4R::AtomEntry$setRights()
- atom4R::AtomEntry$setSource()
- atom4R::AtomEntry$setSummary()
- atom4R::AtomEntry$setTitle()
- atom4R::AtomEntry$setUpdated()
Method new()
Initializes an object of class DCEntry
Usage
DCEntry$new(xml = NULL)
Arguments
- xml
- object of class XMLInternalNode-class from XML 
Method addDCElement()
Adds a Dublin Core element
Usage
DCEntry$addDCElement(term, value, extended = FALSE)
Arguments
- term
- term 
- value
- value 
- extended
- extended. Default is - FALSE
Returns
TRUE if added, FALSE otherwise
Method delDCElement()
Deletes a Dublin Core element
Usage
DCEntry$delDCElement(term, value)
Arguments
- term
- term 
- value
- value 
Returns
TRUE if deleted, FALSE otherwise
Method setDCElements()
Set a list of DC elements
Usage
DCEntry$setDCElements(term, values)
Arguments
- term
- term 
- values
- vector of values 
Method getDCElements()
Get a list of DC elements
Usage
DCEntry$getDCElements(term)
Arguments
- term
- term 
Returns
a list of objects extending DCElement
Method getDCElementByValue()
Get a DC element by value
Usage
DCEntry$getDCElementByValue(term, value)
Arguments
- term
- term 
- value
- value 
Method addDCAbstract()
Adds DC abstract
Usage
DCEntry$addDCAbstract(abstract)
Arguments
- abstract
- object of class DCAbstract or vector of class character and length 1 
Returns
TRUE if added, FALSE otherwise
Method delDCAbstract()
Deletes DC abstract
Usage
DCEntry$delDCAbstract(abstract)
Arguments
- abstract
- object of class DCAbstract or vector of class character and length 1 
Method setDCAbstracts()
Set DC abstracts
Usage
DCEntry$setDCAbstracts(abstracts)
Arguments
- abstracts
- abstracts, vector of class character 
Method getDCAbstracts()
Get DC abstracts
Usage
DCEntry$getDCAbstracts()
Returns
a list of objects of class DCAbstract
Method addDCAccessRights()
Adds DC access rights
Usage
DCEntry$addDCAccessRights(accessRights)
Arguments
- accessRights
- object of class DCAccessRights or vector of class character and length 1 
Returns
TRUE if added, FALSE otherwise
Method delDCAccessRights()
Deletes DC access rights
Usage
DCEntry$delDCAccessRights(accessRights)
Arguments
- accessRights
- object of class DCAccessRights or vector of class character and length 1 
Method setDCAccessRights()
Set access rights
Usage
DCEntry$setDCAccessRights(accessRights)
Arguments
- accessRights
- vector of class character 
Method getDCAccessRights()
Get DC access rights
Usage
DCEntry$getDCAccessRights()
Returns
a list of objects of class DCAccessRights
Method addDCAccrualMethod()
Adds DC accrual method
Usage
DCEntry$addDCAccrualMethod(accrualMethod)
Arguments
- accrualMethod
- object of class DCAccrualMethod or vector of class character and length 1 
Returns
TRUE if added, FALSE otherwise
Method delDCAccrualMethod()
Deletes DC accrual method
Usage
DCEntry$delDCAccrualMethod(accrualMethod)
Arguments
- accrualMethod
- object of class DCAccrualMethod or vector of class character and length 1 
Returns
TRUE if deleted, FALSE otherwise
Method setDCAccrualMethods()
Set DC accrual method
Usage
DCEntry$setDCAccrualMethods(accrualMethods)
Arguments
- accrualMethods
- vector of class character 
Method getDCAccrualMethods()
Get DC accrual method
Usage
DCEntry$getDCAccrualMethods()
Returns
a list of objects of class DCAccrualMethod
Method addDCAccrualPeriodicity()
Adds DC accrual periodicity
Usage
DCEntry$addDCAccrualPeriodicity(accrualPeriodicity)
Arguments
- accrualPeriodicity
- object of class DCAccrualPeriodicity or vector of class character and length 1 
Returns
TRUE if added, FALSE otherwise
Method delDCAccrualPeriodicity()
Deletes DC accrual periodicity
Usage
DCEntry$delDCAccrualPeriodicity(accrualPeriodicity)
Arguments
- accrualPeriodicity
- object of class DCAccrualPeriodicity or vector of class character and length 1 
Returns
TRUE if deleted, FALSE otherwise
Method setDCAccrualPeriodicities()
Set DC accrual periodicities
Usage
DCEntry$setDCAccrualPeriodicities(accrualPeriodicities)
Arguments
- accrualPeriodicities
- vector of class character 
Method getDCAccrualPeriodicities()
Get DC accrual periodicities
Usage
DCEntry$getDCAccrualPeriodicities()
Returns
a list of objects of class DCAccrualPeriodicity
Method addDCAccrualPolicy()
Adds DC accrual policy
Usage
DCEntry$addDCAccrualPolicy(accrualPolicy)
Arguments
- accrualPolicy
- object of class DCAccrualPolicy or vector of class character and length 1 
Returns
TRUE if added, FALSE otherwise
Method delDCAccrualPolicy()
Deletes DC accrual policy
Usage
DCEntry$delDCAccrualPolicy(accrualPolicy)
Arguments
- accrualPolicy
- object of class DCAccrualPolicy or vector of class character and length 1 
Returns
TRUE if deleted, FALSE otherwise
Method setDCAccrualPolicies()
Set DC accrual policies
Usage
DCEntry$setDCAccrualPolicies(accrualPolicies)
Arguments
- accrualPolicies
- vector of class character 
Method getDCAccrualPolicies()
Get DC accrual policies
Usage
DCEntry$getDCAccrualPolicies()
Returns
a list of objects of class DCAccrualPolicy
Method addDCAlternative()
Adds DC alternative
Usage
DCEntry$addDCAlternative(alternative)
Arguments
- alternative
- object of class DCAlternative or vector of class character and length 1 
Returns
TRUE if added, FALSE otherwise
Method delDCAlternative()
Deletes DC alternative
Usage
DCEntry$delDCAlternative(alternative)
Arguments
- alternative
- object of class DCAlternative or vector of class character and length 1 
Returns
TRUE if deleted, FALSE otherwise
Method setDCAlternatives()
Set DC alternatives
Usage
DCEntry$setDCAlternatives(alternatives)
Arguments
- alternatives
- vector of class character 
Method getDCAlternatives()
Get DC alternatives
Usage
DCEntry$getDCAlternatives()
Returns
a list of objects of class DCAlternative
Method addDCAudience()
Adds DC audience
Usage
DCEntry$addDCAudience(audience)
Arguments
- audience
- object of class DCAudience or vector of class character and length 1 
Returns
TRUE if added, FALSE otherwise
Method delDCAudience()
Deletes DC audience
Usage
DCEntry$delDCAudience(audience)
Arguments
- audience
- object of class DCAudience or vector of class character and length 1 
Returns
TRUE if deleted, FALSE otherwise
Method setDCAudiences()
Set DC audiences
Usage
DCEntry$setDCAudiences(audiences)
Arguments
- audiences
- vector of class character 
Method getDCAudiences()
Get DC audiences
Usage
DCEntry$getDCAudiences()
Returns
a list of objects of class DCAudience
Method addDCAvailable()
Adds DC available
Usage
DCEntry$addDCAvailable(available)
Arguments
- available
- object of class DCAvailable or vector of class Date,POSIXt or character and length 1 
Returns
TRUE if added, FALSE otherwise
Method delDCAvailable()
Deletes DC available
Usage
DCEntry$delDCAvailable(available)
Arguments
- available
- object of class DCAvailable or vector of class Date,POSIXt or character and length 1 
Returns
TRUE if deleted, FALSE otherwise
Method setDCAvailables()
Set DC availables
Usage
DCEntry$setDCAvailables(availables)
Arguments
- availables
- vector of class character 
Method getDCAvailables()
Get DC availables
Usage
DCEntry$getDCAvailables()
Returns
a list of objects of class DCAvailable
Method addDCBibliographicCitation()
Adds DC bibliographic citation
Usage
DCEntry$addDCBibliographicCitation(bibliographicCitation)
Arguments
- bibliographicCitation
- object of class DCBibliographicCitation or vector of class character and length 1 
Returns
TRUE if added, FALSE otherwise
Method delDCBibliographicCitation()
Deletes DC bibliographic citation
Usage
DCEntry$delDCBibliographicCitation(bibliographicCitation)
Arguments
- bibliographicCitation
- object of class DCBibliographicCitation or vector of class character and length 1 
Returns
TRUE if deleted, FALSE otherwise
Method setDCBibliographicCitations()
Set bibliographic citations
Usage
DCEntry$setDCBibliographicCitations(bibliographicCitations)
Arguments
- bibliographicCitations
- vector of class character 
Method getDCBibliographicCitations()
Get bibliographic citations
Usage
DCEntry$getDCBibliographicCitations()
Returns
the list of objects of class DCBibliographicCitation
Method addDCConformsTo()
Adds DC conforms to
Usage
DCEntry$addDCConformsTo(conformsTo)
Arguments
- conformsTo
- object of class DCConformsTo or vector of class character and length 1 
Returns
TRUE if added, FALSE otherwise
Method delDCConformsTo()
Deletes DC conforms to
Usage
DCEntry$delDCConformsTo(conformsTo)
Arguments
- conformsTo
- object of class DCConformsTo or vector of class character and length 1 
Returns
TRUE if deleted, FALSE otherwise
Method setDCConformsTo()
Set DC conforms to
Usage
DCEntry$setDCConformsTo(conformsTo)
Arguments
- conformsTo
- vector of class character 
Method getDCConformsTo()
Get DC conforms to
Usage
DCEntry$getDCConformsTo()
Returns
the list of objects of class DCConformsTo
Method addDCContributor()
Adds DC contributor
Usage
DCEntry$addDCContributor(contributor)
Arguments
- contributor
- object of class DCContributor or vector of class character and length 1 
Returns
TRUE if added, FALSE otherwise
Method delDCContributor()
Deletes DC contributor
Usage
DCEntry$delDCContributor(contributor)
Arguments
- contributor
- object of class DCContributor or vector of class character and length 1 
Returns
TRUE if deleted, FALSE otherwise
Method setDCContributors()
Set DC contributors
Usage
DCEntry$setDCContributors(contributors)
Arguments
- contributors
- vector of class character 
Method getDCContributors()
Get DC contributors
Usage
DCEntry$getDCContributors()
Returns
list of objects of class DCContributor
Method addDCCoverage()
Adds DC coverage
Usage
DCEntry$addDCCoverage(coverage)
Arguments
- coverage
- object of class DCCoverage or vector of class character and length 1 
Returns
TRUE if added, FALSE otherwise
Method delDCCoverage()
Deletes DC coverage
Usage
DCEntry$delDCCoverage(coverage)
Arguments
- coverage
- object of class DCCoverage or vector of class character and length 1 
Returns
TRUE if deleted, FALSE otherwise
Method setDCCoverages()
Set DC coverages
Usage
DCEntry$setDCCoverages(coverages)
Arguments
- coverages
- coverages vector of class character 
Method getDCCoverages()
Get DC coverages
Usage
DCEntry$getDCCoverages()
Returns
a list of objects of class DCCoverage
Method addDCCreated()
Adds DC created
Usage
DCEntry$addDCCreated(created)
Arguments
Returns
TRUE if added, FALSE otherwise
Method delDCCreated()
Deletes DC created
Usage
DCEntry$delDCCreated(created)
Arguments
Returns
TRUE if deleted, FALSE otherwise
Method addDCCreator()
Adds DC creator
Usage
DCEntry$addDCCreator(creator)
Arguments
Returns
TRUE if added, FALSE otherwise
Method delDCCreator()
Deletes DC creator
Usage
DCEntry$delDCCreator(creator)
Arguments
Returns
TRUE if deleted, FALSE otherwise
Method setDCCreators()
Set DC creators
Usage
DCEntry$setDCCreators(creators)
Arguments
- creators
- creators 
Method getDCCreators()
Get DC creators
Usage
DCEntry$getDCCreators()
Returns
a list of objects of class DCCreator
Method addDCDate()
Adds DC date
Usage
DCEntry$addDCDate(date)
Arguments
Returns
TRUE if added, FALSE otherwise
Method delDCDate()
Deletes DC date
Usage
DCEntry$delDCDate(date)
Arguments
Returns
TRUE if deleted, FALSE otherwise
Method setDCDates()
Set DC Creators
Usage
DCEntry$setDCDates(dates)
Arguments
Method getDCDates()
Get DC Dates
Usage
DCEntry$getDCDates()
Returns
a list of objects of class DCDate
Method addDCDateAccepted()
Adds DC date accepted
Usage
DCEntry$addDCDateAccepted(dateAccepted)
Arguments
- dateAccepted
- object of class DCDateAccepted or vector of class Date,POSIXt or character and length 1 
Returns
TRUE if added, FALSE otherwise
Method delDCDateAccepted()
Deletes DC date accepted
Usage
DCEntry$delDCDateAccepted(dateAccepted)
Arguments
- dateAccepted
- object of class DCDateAccepted or vector of class Date,POSIXt or character and length 1 
Returns
TRUE if deleted, FALSE otherwise
Method addDCDateCopyrighted()
Adds DC date copyrighted
Usage
DCEntry$addDCDateCopyrighted(dateCopyrighted)
Arguments
- dateCopyrighted
- object of class DCDateCopyrighted or vector of class Date,POSIXt or character and length 1 
Returns
TRUE if added, FALSE otherwise
Method delDCDateCopyrighted()
Deletes DC date copyrighted
Usage
DCEntry$delDCDateCopyrighted(dateCopyrighted)
Arguments
- dateCopyrighted
- object of class DCDateCopyrighted or vector of class Date,POSIXt or character and length 1 
Returns
TRUE if deleted, FALSE otherwise
Method addDCDateSubmitted()
Adds DC date submitted
Usage
DCEntry$addDCDateSubmitted(dateSubmitted)
Arguments
- dateSubmitted
- object of class DCDateSubmitted or vector of class Date,POSIXt or character and length 1 
Returns
TRUE if added, FALSE otherwise
Method delDCDateSubmitted()
Deletes DC date submitted
Usage
DCEntry$delDCDateSubmitted(dateSubmitted)
Arguments
- dateSubmitted
- object of class DCDateSubmitted or vector of class Date,POSIXt or character and length 1 
Returns
TRUE if deleted, FALSE otherwise
Method addDCDescription()
Adds DC description
Usage
DCEntry$addDCDescription(description)
Arguments
- description
- object of class DCDescription or vector of class character and length 1 
Returns
TRUE if added, FALSE otherwise
Method delDCDescription()
Deletes DC description
Usage
DCEntry$delDCDescription(description)
Arguments
- description
- object of class DCDescription or vector of class character and length 1 
Returns
TRUE if deleted, FALSE otherwise
Method setDCDescriptions()
Set DC descriptions
Usage
DCEntry$setDCDescriptions(descriptions)
Arguments
- descriptions
- vector of class character 
Method getDCDescriptions()
Get DC descriptions
Usage
DCEntry$getDCDescriptions()
Returns
a list of objects of class DCDescription
Method addDCEducationalLevel()
Adds DC educational level
Usage
DCEntry$addDCEducationalLevel(educationalLevel)
Arguments
- educationalLevel
- object of class DCEducationalLevel or vector of class character and length 1 
Returns
TRUE if added, FALSE otherwise
Method delDCEducationalLevel()
Deletes DC educational level
Usage
DCEntry$delDCEducationalLevel(educationalLevel)
Arguments
- educationalLevel
- object of class DCEducationalLevel or vector of class character and length 1 
Returns
TRUE if deleted, FALSE otherwise
Method setDCEducationalLevels()
set DC education levels
Usage
DCEntry$setDCEducationalLevels(educationLevels)
Arguments
- educationLevels
- vector of class character 
Method getDCEducationalLevels()
Get DC educational levels
Usage
DCEntry$getDCEducationalLevels()
Returns
a list of objects of class DCEducationalLevel
Method addDCExtent()
Adds DC extent
Usage
DCEntry$addDCExtent(extent)
Arguments
Returns
TRUE if added, FALSE otherwise
Method delDCExtent()
Deletes DC extent
Usage
DCEntry$delDCExtent(extent)
Arguments
Returns
TRUE if deleted, FALSE otherwise
Method setDCExtents()
Set DC extents
Usage
DCEntry$setDCExtents(extents)
Arguments
- extents
- vector of class character 
Method getDCExtents()
Get DC extents
Usage
DCEntry$getDCExtents()
Returns
a list of objects of class DCExtent
Method addDCFormat()
Adds DC format
Usage
DCEntry$addDCFormat(format)
Arguments
Returns
TRUE if added, FALSE otherwise
Method delDCFormat()
Deletes DC format
Usage
DCEntry$delDCFormat(format)
Arguments
Returns
TRUE if deleted, FALSE otherwise
Method setDCFormats()
Set DC formats
Usage
DCEntry$setDCFormats(formats)
Arguments
- formats
- vector of class character 
Method getDCFormats()
Get DC formats
Usage
DCEntry$getDCFormats()
Returns
a list of objects of class DCFormat
Method addDCHasPart()
Adds DC hasPart
Usage
DCEntry$addDCHasPart(hasPart)
Arguments
Returns
TRUE if added, FALSE otherwise
Method delDCHasPart()
Deletes DC hasPart
Usage
DCEntry$delDCHasPart(hasPart)
Arguments
Returns
TRUE if deleted, FALSE otherwise
Method setDCHasParts()
Set DC hasParts
Usage
DCEntry$setDCHasParts(hasParts)
Arguments
- hasParts
- vector of class character 
Method getDCHasParts()
Get DC has part
Usage
DCEntry$getDCHasParts()
Returns
a list of objects of class DCHasPart
Method addDCHasVersion()
Adds DC hasVersion
Usage
DCEntry$addDCHasVersion(hasVersion)
Arguments
- hasVersion
- object of class DCHasVersion or vector of class character and length 1 
Returns
TRUE if added, FALSE otherwise
Method delDCHasVersion()
Deletes DC hasVersion
Usage
DCEntry$delDCHasVersion(hasVersion)
Arguments
- hasVersion
- object of class DCHasVersion or vector of class character and length 1 
Returns
TRUE if deleted, FALSE otherwise
Method setDCHasVersions()
Set DC hasVersions
Usage
DCEntry$setDCHasVersions(hasVersions)
Arguments
- hasVersions
- vector of class character 
Method getDCHasVersions()
Get DC has versions
Usage
DCEntry$getDCHasVersions()
Returns
a list of objects of class DCHasVersion
Method addDCIdentifier()
Adds DC identifier
Usage
DCEntry$addDCIdentifier(identifier)
Arguments
- identifier
- object of class DCIdentifier or vector of class character and length 1 
Returns
TRUE if added, FALSE otherwise
Method delDCIdentifier()
Deletes DC identifier
Usage
DCEntry$delDCIdentifier(identifier)
Arguments
- identifier
- object of class DCIdentifier or vector of class character and length 1 
Returns
TRUE if deleted, FALSE otherwise
Method setDCIdentifiers()
Set DC identifiers
Usage
DCEntry$setDCIdentifiers(identifiers)
Arguments
- identifiers
- vector of class character 
Method getDCIdentifiers()
Get DC identifiers
Usage
DCEntry$getDCIdentifiers()
Returns
a list of objects of class DCIdentifier
Method addDCInstructionalMethod()
Adds DC instructionalMethod
Usage
DCEntry$addDCInstructionalMethod(instructionalMethod)
Arguments
- instructionalMethod
- object of class DCInstructionalMethod or vector of class character and length 1 
Returns
TRUE if added, FALSE otherwise
Method delDCInstructionalMethod()
Deletes DC instructionalMethod
Usage
DCEntry$delDCInstructionalMethod(instructionalMethod)
Arguments
- instructionalMethod
- object of class DCInstructionalMethod or vector of class character and length 1 
Returns
TRUE if deleted, FALSE otherwise
Method setDCInstructionalMethods()
Set DC Instructional methods
Usage
DCEntry$setDCInstructionalMethods(instructionalMethods)
Arguments
- instructionalMethods
- vector of class character 
Method getDCInstructionalMethods()
Get DC instructional methods
Usage
DCEntry$getDCInstructionalMethods()
Returns
a list of objects of class DCInstructionalMethod
Method addDCIsPartOf()
Adds DC isPartOf
Usage
DCEntry$addDCIsPartOf(isPartOf)
Arguments
- isPartOf
- object of class DCIsPartOf or vector of class character and length 1 
Returns
TRUE if added, FALSE otherwise
Method delDCIsPartOf()
Deletes DC isPartOf
Usage
DCEntry$delDCIsPartOf(isPartOf)
Arguments
- isPartOf
- object of class DCIsPartOf or vector of class character and length 1 
Returns
TRUE if deleted, FALSE otherwise
Method setDCIsPartOf()
Set DC IsPartOf
Usage
DCEntry$setDCIsPartOf(isPartOf)
Arguments
- isPartOf
- vector of class character 
Method getDCIsPartOfs()
Get DC Is Part of
Usage
DCEntry$getDCIsPartOfs()
Returns
a list of objects of class DCIsPartOf
Method addDCIsReferencedBy()
Adds DC isReferencedBy
Usage
DCEntry$addDCIsReferencedBy(isReferencedBy)
Arguments
- isReferencedBy
- object of class DCIsReferencedBy or vector of class character and length 1 
Returns
TRUE if added, FALSE otherwise
Method delDCIsReferencedBy()
Deletes DC isReferencedBy
Usage
DCEntry$delDCIsReferencedBy(isReferencedBy)
Arguments
- isReferencedBy
- object of class DCIsReferencedBy or vector of class character and length 1 
Returns
TRUE if deleted, FALSE otherwise
Method setDCIsReferencedBys()
Set DC isReferencedBys
Usage
DCEntry$setDCIsReferencedBys(isReferencedBys)
Arguments
- isReferencedBys
- vector of class character 
Method getDCIsReferencedBys()
Get DC Is Referenced by
Usage
DCEntry$getDCIsReferencedBys()
Returns
a list of objects of class DCIsReferencedBy
Method addDCIsReplacedBy()
Adds DC isReplacedBy
Usage
DCEntry$addDCIsReplacedBy(isReplacedBy)
Arguments
- isReplacedBy
- object of class DCIsReplacedBy or vector of class character and length 1 
Returns
TRUE if added, FALSE otherwise
Method delDCIsReplacedBy()
Deletes DC isReferencedBy
Usage
DCEntry$delDCIsReplacedBy(isReplacedBy)
Arguments
- isReplacedBy
- object of class DCIsReplacedBy or vector of class character and length 1 
Returns
TRUE if deleted, FALSE otherwise
Method setDCIsReplacedBys()
Set DC isReplacedBys
Usage
DCEntry$setDCIsReplacedBys(isReplacedBys)
Arguments
- isReplacedBys
- vector of class character 
Method getDCIsReplacedBys()
Get DC Is Replaced by
Usage
DCEntry$getDCIsReplacedBys()
Returns
a list of objects of class DCIsReplacedBy
Method addDCIsRequiredBy()
Adds DC isRequiredBy
Usage
DCEntry$addDCIsRequiredBy(isRequiredBy)
Arguments
- isRequiredBy
- object of class DCIsRequiredBy or vector of class character and length 1 
Returns
TRUE if added, FALSE otherwise
Method delDCIsRequiredBy()
Deletes DC isRequiredBy
Usage
DCEntry$delDCIsRequiredBy(isRequiredBy)
Arguments
- isRequiredBy
- object of class DCIsRequiredBy or vector of class character and length 1 
Returns
TRUE if deleted, FALSE otherwise
Method setDCIsRequiredBys()
Set DC isRequiredBys
Usage
DCEntry$setDCIsRequiredBys(isRequiredBys)
Arguments
- isRequiredBys
- vector of class character 
Method getDCIsRequiredBys()
Get DC Is Required by
Usage
DCEntry$getDCIsRequiredBys()
Returns
a list of objects of class DCIsRequiredBy
Method addDCIsVersionOf()
Adds DC isVersionOf
Usage
DCEntry$addDCIsVersionOf(isVersionOf)
Arguments
- isVersionOf
- object of class DCIsVersionOf or vector of class character and length 1 
Returns
TRUE if added, FALSE otherwise
Method delDCIsVersionOf()
Deletes DC isVersionOf
Usage
DCEntry$delDCIsVersionOf(isVersionOf)
Arguments
- isVersionOf
- object of class DCIsVersionOf or vector of class character and length 1 
Returns
TRUE if deleted, FALSE otherwise
Method setDCIsVersionOfs()
Set DC isVersionOfs
Usage
DCEntry$setDCIsVersionOfs(isVersionOfs)
Arguments
- isVersionOfs
- vector of class character 
Method getDCIsVersionOfs()
Get DC Is Version Ofs
Usage
DCEntry$getDCIsVersionOfs()
Returns
a list of objects of class DCIsVersionOf
Method addDCIssued()
Adds DC issued
Usage
DCEntry$addDCIssued(issued)
Arguments
Returns
TRUE if added, FALSE otherwise
Method delDCIssued()
Deletes DC issued
Usage
DCEntry$delDCIssued(issued)
Arguments
Returns
TRUE if deleted, FALSE otherwise
Method addDCLanguage()
Adds DC language
Usage
DCEntry$addDCLanguage(language)
Arguments
- language
- object of class DCLanguage or vector of class character and length 1 
Returns
TRUE if added, FALSE otherwise
Method delDCLanguage()
Deletes DC language
Usage
DCEntry$delDCLanguage(language)
Arguments
- language
- object of class DCLanguage or vector of class character and length 1 
Returns
TRUE if deleted, FALSE otherwise
Method setDCLanguages()
Set DC languages
Usage
DCEntry$setDCLanguages(languages)
Arguments
- languages
- languages vector of class character 
Method getDCLanguages()
Get languages
Usage
DCEntry$getDCLanguages()
Returns
a list of objects of class DCLanguage
Method addDCLicense()
Adds DC license
Usage
DCEntry$addDCLicense(license)
Arguments
Returns
TRUE if added, FALSE otherwise
Method delDCLicense()
Deletes DC license
Usage
DCEntry$delDCLicense(license)
Arguments
Returns
TRUE if deleted, FALSE otherwise
Method setDCLicenses()
Set DC licences
Usage
DCEntry$setDCLicenses(licenses)
Arguments
- licenses
- vector of class character 
Method getDCLicenses()
Get DC licenses
Usage
DCEntry$getDCLicenses()
Returns
a list of objects of class DCLicense
Method addDCMediator()
Adds DC mediator
Usage
DCEntry$addDCMediator(mediator)
Arguments
- mediator
- object of class DCMediator or vector of class character and length 1 
Returns
TRUE if added, FALSE otherwise
Method delDCMediator()
Deletes DC mediator
Usage
DCEntry$delDCMediator(mediator)
Arguments
- mediator
- object of class DCMediator or vector of class character and length 1 
Returns
TRUE if deleted, FALSE otherwise
Method setDCMediators()
Set DC mediators
Usage
DCEntry$setDCMediators(mediators)
Arguments
- mediators
- vector of class character 
Method getDCMediators()
Get DC mediators
Usage
DCEntry$getDCMediators()
Returns
a list of objects of class DCMediator
Method addDCMedium()
Adds DC medium
Usage
DCEntry$addDCMedium(medium)
Arguments
Returns
TRUE if added, FALSE otherwise
Method delDCMedium()
Deletes DC medium
Usage
DCEntry$delDCMedium(medium)
Arguments
Returns
TRUE if deleted, FALSE otherwise
Method setDCMediums()
Set DC mediums
Usage
DCEntry$setDCMediums(mediums)
Arguments
- mediums
- vector of class character 
Method getDCMediums()
Get DC mediums
Usage
DCEntry$getDCMediums()
Returns
a list of objects of class DCMedium
Method addDCModified()
Adds DC modified
Usage
DCEntry$addDCModified(modified)
Arguments
- modified
- object of class DCModified or vector of class Date,POSIXt or character and length 1 
Returns
TRUE if added, FALSE otherwise
Method delDCModified()
Deletes DC modified
Usage
DCEntry$delDCModified(modified)
Arguments
- modified
- object of class DCModified or vector of class Date,POSIXt or character and length 1 
Returns
TRUE if deletes, FALSE otherwise
Method addDCProvenance()
Adds DC provenance
Usage
DCEntry$addDCProvenance(provenance)
Arguments
- provenance
- object of class DCProvenance or vector of class character and length 1 
Returns
TRUE if added, FALSE otherwise
Method delDCProvenance()
Deletes DC provenance
Usage
DCEntry$delDCProvenance(provenance)
Arguments
- provenance
- object of class DCProvenance or vector of class character and length 1 
Returns
TRUE if deleted, FALSE otherwise
Method setDCProvenances()
Set DC provenances
Usage
DCEntry$setDCProvenances(provenances)
Arguments
- provenances
- vector of class character 
Method getDCProvenances()
Get DC provenances
Usage
DCEntry$getDCProvenances()
Returns
a list of objects of class DCProvenance
Method addDCPublisher()
Adds DC publisher
Usage
DCEntry$addDCPublisher(publisher)
Arguments
- publisher
- object of class DCPublisher or vector of class character and length 1 
Returns
TRUE if added, FALSE otherwise
Method delDCPublisher()
Deletes DC publisher
Usage
DCEntry$delDCPublisher(publisher)
Arguments
- publisher
- object of class DCPublisher or vector of class character and length 1 
Returns
TRUE if deleted, FALSE otherwise
Method setDCPublishers()
Set DC publishers
Usage
DCEntry$setDCPublishers(publishers)
Arguments
- publishers
- vector of class character 
Method getDCPublishers()
Get DC publishers
Usage
DCEntry$getDCPublishers()
Returns
a list of objects of class DCPublisher
Method addDCReferences()
Adds DC references
Usage
DCEntry$addDCReferences(references)
Arguments
- references
- object of class DCReferences or vector of class character and length 1 
Returns
TRUE if added, FALSE otherwise
Method delDCReferences()
Deletes DC references
Usage
DCEntry$delDCReferences(references)
Arguments
- references
- object of class DCReferences or vector of class character and length 1 
Returns
TRUE if deleted, FALSE otherwise
Method setDCReferences()
Set DC references
Usage
DCEntry$setDCReferences(references)
Arguments
- references
- vector of class character 
Method getDCReferences()
Get DC references
Usage
DCEntry$getDCReferences()
Returns
a list of objects of class DCReferences
Method addDCRelation()
Adds DC relation
Usage
DCEntry$addDCRelation(relation)
Arguments
- relation
- object of class DCRelation or vector of class character and length 1 
Returns
TRUE if added, FALSE otherwise
Method delDCRelation()
Deletes DC relation
Usage
DCEntry$delDCRelation(relation)
Arguments
- relation
- object of class DCRelation or vector of class character and length 1 
Returns
TRUE if deleted, FALSE otherwise
Method setDCRelations()
Set DC relations
Usage
DCEntry$setDCRelations(relations)
Arguments
- relations
- vector of class character 
Method getDCRelations()
Get DC relations
Usage
DCEntry$getDCRelations()
Returns
a list of objects of class DCRelation
Method addDCReplaces()
Adds DC replaces
Usage
DCEntry$addDCReplaces(replaces)
Arguments
- replaces
- object of class DCReplaces or vector of class character and length 1 
Returns
TRUE if added, FALSE otherwise
Method delDCReplaces()
Deletes DC replaces
Usage
DCEntry$delDCReplaces(replaces)
Arguments
- replaces
- object of class DCReplaces or vector of class character and length 1 
Returns
TRUE if deleted, FALSE otherwise
Method setDCReplaces()
Set DC replaces
Usage
DCEntry$setDCReplaces(replaces)
Arguments
- replaces
- vector of class character 
Method getDCReplaces()
Get DC replaces
Usage
DCEntry$getDCReplaces()
Returns
a list of objects of class DCReplaces
Method addDCRequires()
Adds DC requires
Usage
DCEntry$addDCRequires(requires)
Arguments
- requires
- object of class DCRequires or vector of class character and length 1 
Returns
TRUE if added, FALSE otherwise
Method delDCRequires()
Deletes DC requires
Usage
DCEntry$delDCRequires(requires)
Arguments
- requires
- object of class DCRequires or vector of class character and length 1 
Returns
TRUE if deleted, FALSE otherwise
Method setDCRequires()
Set DC requires
Usage
DCEntry$setDCRequires(requires)
Arguments
- requires
- vector of class character 
Method getDCRequires()
Get DC requires
Usage
DCEntry$getDCRequires()
Returns
a list of objects of class DCRequires
Method addDCRights()
Adds DC rights
Usage
DCEntry$addDCRights(rights)
Arguments
Returns
TRUE if added, FALSE otherwise
Method delDCRights()
Deletes DC rights
Usage
DCEntry$delDCRights(rights)
Arguments
Returns
TRUE if deleted, FALSE otherwise
Method setDCRights()
Set DC rights
Usage
DCEntry$setDCRights(rights)
Arguments
- rights
- vector of class character 
Method getDCRights()
Get DC rights
Usage
DCEntry$getDCRights()
Returns
a list of objects of class DCRights
Method addDCRightsHolder()
Adds DC rightsHolder
Usage
DCEntry$addDCRightsHolder(rightsHolder)
Arguments
- rightsHolder
- object of class DCRightsHolder or vector of class character and length 1 
Returns
TRUE if added, FALSE otherwise
Method delDCRightsHolder()
Deletes DC rightsHolder
Usage
DCEntry$delDCRightsHolder(rightsHolder)
Arguments
- rightsHolder
- object of class DCRightsHolder or vector of class character and length 1 
Returns
TRUE if deleted, FALSE otherwise
Method setDCRightsHolders()
Set DC rights holders
Usage
DCEntry$setDCRightsHolders(rightsHolders)
Arguments
- rightsHolders
- vector of class character 
Method getDCRightsHolders()
Get DC rights holders
Usage
DCEntry$getDCRightsHolders()
Returns
a list of objects of class DCRightsHolder
Method addDCSource()
Adds DC source
Usage
DCEntry$addDCSource(source)
Arguments
Returns
TRUE if added, FALSE otherwise
Method delDCSource()
Deletes DC source
Usage
DCEntry$delDCSource(source)
Arguments
Returns
TRUE if deleted, FALSE otherwise
Method setDCSources()
Set DC sources
Usage
DCEntry$setDCSources(sources)
Arguments
- sources
- vector of class character 
Method getDCSources()
Get DC sources
Usage
DCEntry$getDCSources()
Returns
a list of objects of class DCSource
Method addDCSubject()
Adds DC subject
Usage
DCEntry$addDCSubject(subject)
Arguments
Returns
TRUE if added, FALSE otherwise
Method delDCSubject()
Deletes DC subject
Usage
DCEntry$delDCSubject(subject)
Arguments
Returns
TRUE if deleted, FALSE otherwise
Method setDCSubjects()
Set DC subjects
Usage
DCEntry$setDCSubjects(subjects)
Arguments
- subjects
- vector of class character 
Method getDCSubjects()
Get DC Subjects
Usage
DCEntry$getDCSubjects()
Returns
a list of objects of class DCSubject
Method addDCTableOfContents()
Adds DC tableOfContents
Usage
DCEntry$addDCTableOfContents(tableOfContents)
Arguments
- tableOfContents
- object of class DCTableOfContents or vector of class character and length 1 
Returns
TRUE if added, FALSE otherwise
Method delDCTableOfContents()
Deletes DC tableOfContents
Usage
DCEntry$delDCTableOfContents(tableOfContents)
Arguments
- tableOfContents
- object of class DCTableOfContents or vector of class character and length 1 
Returns
TRUE if deleted, FALSE otherwise
Method setDCTablesOfContents()
Set DC tables of contents
Usage
DCEntry$setDCTablesOfContents(tablesOfContents)
Arguments
- tablesOfContents
- vector of class character 
Method getDCTablesOfContent()
Get DC tables of contents
Usage
DCEntry$getDCTablesOfContent()
Returns
a list of objects of class DCTableOfContents
Method addDCTemporal()
Adds DC temporal
Usage
DCEntry$addDCTemporal(temporal)
Arguments
- temporal
- object of class DCTemporal or vector of class character and length 1 
Returns
TRUE if added, FALSE otherwise
Method delDCTemporal()
Deletes DC temporal
Usage
DCEntry$delDCTemporal(temporal)
Arguments
- temporal
- object of class DCTemporal or vector of class character and length 1 
Returns
TRUE if deleted, FALSE otherwise
Method setDCTemporals()
Set DC temporals
Usage
DCEntry$setDCTemporals(temporals)
Arguments
- temporals
- vector of class character 
Method getDCTemporals()
Get DC temporals
Usage
DCEntry$getDCTemporals()
Returns
a list of objects of class DCTemporal
Method addDCTitle()
Adds DC title
Usage
DCEntry$addDCTitle(title)
Arguments
Returns
TRUE if added, FALSE otherwise
Method delDCTitle()
Deletes DC title
Usage
DCEntry$delDCTitle(title)
Arguments
Returns
TRUE if deleted, FALSE otherwise
Method setDCTitles()
Set DC titles
Usage
DCEntry$setDCTitles(titles)
Arguments
- titles
- vector of class character 
Method getDCTitles()
Get DC titles
Usage
DCEntry$getDCTitles()
Returns
a list of objects of class DCTitle
Method addDCType()
Adds DC type
Usage
DCEntry$addDCType(type)
Arguments
Returns
TRUE if added, FALSE otherwise
Method delDCType()
Deletes DC type
Usage
DCEntry$delDCType(type)
Arguments
Returns
TRUE if deleted, FALSE otherwise
Method setDCTypes()
Set DC Types
Usage
DCEntry$setDCTypes(types)
Arguments
- types
- vector of class character 
Method getDCTypes()
Get DC types
Usage
DCEntry$getDCTypes()
Returns
a list of objects of class DCType
Method asDataFrame()
export to a data.frame
Usage
DCEntry$asDataFrame()
Returns
an object of class data.frame
Method clone()
The objects of this class are cloneable with this method.
Usage
DCEntry$clone(deep = FALSE)
Arguments
- deep
- Whether to make a deep clone. 
Author(s)
Emmanuel Blondel <emmanuel.blondel1@gmail.com>
Examples
 
  #encoding
  dcentry <- DCEntry$new()
  dcentry$setId("my-dc-entry")
  #fill dc entry
  dcentry$addDCDate(Sys.time())
  dcentry$addDCTitle("atom4R - Tools to read/write and publish metadata as Atom XML format")
  dcentry$addDCType("Software")
  creator <- DCCreator$new(value = "Blondel, Emmanuel")
  creator$attrs[["affiliation"]] <- "Independent"
  dcentry$addDCCreator(creator)
  dcentry$addDCSubject("R")
  dcentry$addDCSubject("FAIR")
  dcentry$addDCSubject("Interoperability")
  dcentry$addDCSubject("Open Science")
  dcentry$addDCDescription("Atom4R offers tools to read/write and publish metadata as Atom XML")
  dcentry$addDCPublisher("GitHub")
  funder <- DCContributor$new(value = "CNRS")
  funder$attrs[["type"]] <- "Funder"
  dcentry$addDCContributor(funder)
  dcentry$addDCRelation("Github repository: https://github.com/eblondel/atom4R")
  dcentry$addDCSource("Atom Syndication format - https://www.ietf.org/rfc/rfc4287")
  dcentry$addDCSource("AtomPub, The Atom publishing protocol - https://tools.ietf.org/html/rfc5023")
  dcentry$addDCSource("Sword API - http://swordapp.org/")
  dcentry$addDCSource("Dublin Core Metadata Initiative - https://www.dublincore.org/")
  dcentry$addDCSource("Guidelines for implementing Dublin Core in XML")
  dcentry$addDCLicense("NONE")
  dcentry$addDCRights("MIT License")
  dcentry$addDCHasPart("part1")
  dcentry$addDCHasPart("part2")
  dcentry$addDCHasVersion("0.2")
  dcentry$addDCIsPartOf("CRAN")
  dcentry$addDCIsPartOf("GitHub")
  dcentry$addDCIsReferencedBy("CRAN")
  dcentry$addDCIsReferencedBy("GitHub")
  dcentry$addDCIsRequiredBy("zen4R")
  dcentry$addDCIsRequiredBy("cloud4R")
  xml <- dcentry$encode()
  #decoding
  dcentry2 <- DCEntry$new(xml = xml)
  xml2 <- dcentry2$encode()
 
DCExtent
Description
This class models an DublinCore 'extent' element
Format
 R6Class object.
Value
Object of  R6Class for modelling an Dublin Core 'extent' element
Super classes
atom4R::atom4RLogger -> atom4R::AtomAbstractObject -> atom4R::DCElement -> atom4R::DCFormat -> DCExtent
Methods
Public methods
Inherited methods
- atom4R::atom4RLogger$ERROR()
- atom4R::atom4RLogger$INFO()
- atom4R::atom4RLogger$WARN()
- atom4R::atom4RLogger$logger()
- atom4R::AtomAbstractObject$addListElement()
- atom4R::AtomAbstractObject$contains()
- atom4R::AtomAbstractObject$createElement()
- atom4R::AtomAbstractObject$decode()
- atom4R::AtomAbstractObject$delListElement()
- atom4R::AtomAbstractObject$encode()
- atom4R::AtomAbstractObject$getClass()
- atom4R::AtomAbstractObject$getClassName()
- atom4R::AtomAbstractObject$getNamespace()
- atom4R::AtomAbstractObject$getNamespaceDefinition()
- atom4R::AtomAbstractObject$getRootElement()
- atom4R::AtomAbstractObject$getXmlElement()
- atom4R::AtomAbstractObject$isDocument()
- atom4R::AtomAbstractObject$isFieldInheritedFrom()
- atom4R::AtomAbstractObject$print()
- atom4R::AtomAbstractObject$save()
- atom4R::AtomAbstractObject$setIsDocument()
- atom4R::AtomAbstractObject$validate()
Method new()
Initializes an object of class DCExtent
Usage
DCExtent$new(xml = NULL, value = NULL)
Arguments
- xml
- object of class XMLInternalNode-class from XML 
- value
- value 
Method clone()
The objects of this class are cloneable with this method.
Usage
DCExtent$clone(deep = FALSE)
Arguments
- deep
- Whether to make a deep clone. 
References
Dublin Core Metadata Initiative. https://www.dublincore.org/specifications/dublin-core/dcmi-terms/terms/extent
DCFormat
Description
This class models an DublinCore 'format' element
Format
 R6Class object.
Value
Object of  R6Class for modelling an Dublin Core 'format' element
Super classes
atom4R::atom4RLogger -> atom4R::AtomAbstractObject -> atom4R::DCElement -> DCFormat
Methods
Public methods
Inherited methods
- atom4R::atom4RLogger$ERROR()
- atom4R::atom4RLogger$INFO()
- atom4R::atom4RLogger$WARN()
- atom4R::atom4RLogger$logger()
- atom4R::AtomAbstractObject$addListElement()
- atom4R::AtomAbstractObject$contains()
- atom4R::AtomAbstractObject$createElement()
- atom4R::AtomAbstractObject$decode()
- atom4R::AtomAbstractObject$delListElement()
- atom4R::AtomAbstractObject$encode()
- atom4R::AtomAbstractObject$getClass()
- atom4R::AtomAbstractObject$getClassName()
- atom4R::AtomAbstractObject$getNamespace()
- atom4R::AtomAbstractObject$getNamespaceDefinition()
- atom4R::AtomAbstractObject$getRootElement()
- atom4R::AtomAbstractObject$getXmlElement()
- atom4R::AtomAbstractObject$isDocument()
- atom4R::AtomAbstractObject$isFieldInheritedFrom()
- atom4R::AtomAbstractObject$print()
- atom4R::AtomAbstractObject$save()
- atom4R::AtomAbstractObject$setIsDocument()
- atom4R::AtomAbstractObject$validate()
Method new()
Initializes an object of class DCFormat
Usage
DCFormat$new(xml = NULL, term = NULL, value = NULL)
Arguments
- xml
- object of class XMLInternalNode-class from XML 
- term
- term 
- value
- value 
Method clone()
The objects of this class are cloneable with this method.
Usage
DCFormat$clone(deep = FALSE)
Arguments
- deep
- Whether to make a deep clone. 
References
Dublin Core Metadata Initiative. https://www.dublincore.org/specifications/dublin-core/dcmi-terms/terms/format
DCHasPart
Description
This class models an DublinCore 'hasPart' element
Format
 R6Class object.
Value
Object of  R6Class for modelling an Dublin Core Terms 'hasPart' element
Super classes
atom4R::atom4RLogger -> atom4R::AtomAbstractObject -> atom4R::DCElement -> DCHasPart
Methods
Public methods
Inherited methods
- atom4R::atom4RLogger$ERROR()
- atom4R::atom4RLogger$INFO()
- atom4R::atom4RLogger$WARN()
- atom4R::atom4RLogger$logger()
- atom4R::AtomAbstractObject$addListElement()
- atom4R::AtomAbstractObject$contains()
- atom4R::AtomAbstractObject$createElement()
- atom4R::AtomAbstractObject$decode()
- atom4R::AtomAbstractObject$delListElement()
- atom4R::AtomAbstractObject$encode()
- atom4R::AtomAbstractObject$getClass()
- atom4R::AtomAbstractObject$getClassName()
- atom4R::AtomAbstractObject$getNamespace()
- atom4R::AtomAbstractObject$getNamespaceDefinition()
- atom4R::AtomAbstractObject$getRootElement()
- atom4R::AtomAbstractObject$getXmlElement()
- atom4R::AtomAbstractObject$isDocument()
- atom4R::AtomAbstractObject$isFieldInheritedFrom()
- atom4R::AtomAbstractObject$print()
- atom4R::AtomAbstractObject$save()
- atom4R::AtomAbstractObject$setIsDocument()
- atom4R::AtomAbstractObject$validate()
Method new()
This method is used to create an Dublin core 'hasPart' element.
Use dc to TRUE to use Dublin core namespace instead of DC terms.
Usage
DCHasPart$new(xml = NULL, value = NULL, dc = FALSE)
Arguments
- xml
- object of class XMLInternalNode-class from XML 
- value
- value 
- dc
- use DC namespace? 
Method clone()
The objects of this class are cloneable with this method.
Usage
DCHasPart$clone(deep = FALSE)
Arguments
- deep
- Whether to make a deep clone. 
References
Dublin Core Metadata Initiative. https://www.dublincore.org/specifications/dublin-core/dcmi-terms/#http://purl.org/dc/terms/hasPart
DCHasVersion
Description
This class models an DublinCore 'hasVersion' element
Format
 R6Class object.
Value
Object of  R6Class for modelling an Dublin Core Terms 'hasPart' element
Super classes
atom4R::atom4RLogger -> atom4R::AtomAbstractObject -> atom4R::DCElement -> DCHasVersion
Methods
Public methods
Inherited methods
- atom4R::atom4RLogger$ERROR()
- atom4R::atom4RLogger$INFO()
- atom4R::atom4RLogger$WARN()
- atom4R::atom4RLogger$logger()
- atom4R::AtomAbstractObject$addListElement()
- atom4R::AtomAbstractObject$contains()
- atom4R::AtomAbstractObject$createElement()
- atom4R::AtomAbstractObject$decode()
- atom4R::AtomAbstractObject$delListElement()
- atom4R::AtomAbstractObject$encode()
- atom4R::AtomAbstractObject$getClass()
- atom4R::AtomAbstractObject$getClassName()
- atom4R::AtomAbstractObject$getNamespace()
- atom4R::AtomAbstractObject$getNamespaceDefinition()
- atom4R::AtomAbstractObject$getRootElement()
- atom4R::AtomAbstractObject$getXmlElement()
- atom4R::AtomAbstractObject$isDocument()
- atom4R::AtomAbstractObject$isFieldInheritedFrom()
- atom4R::AtomAbstractObject$print()
- atom4R::AtomAbstractObject$save()
- atom4R::AtomAbstractObject$setIsDocument()
- atom4R::AtomAbstractObject$validate()
Method new()
This method is used to create an Dublin core 'hasVersion' element.
Use dc to TRUE to use Dublin core namespace instead of DC terms.
Usage
DCHasVersion$new(xml = NULL, value = NULL, dc = FALSE)
Arguments
- xml
- object of class XMLInternalNode-class from XML 
- value
- value 
- dc
- use DC namespace? 
Method clone()
The objects of this class are cloneable with this method.
Usage
DCHasVersion$clone(deep = FALSE)
Arguments
- deep
- Whether to make a deep clone. 
References
Dublin Core Metadata Initiative. https://www.dublincore.org/specifications/dublin-core/dcmi-terms/#http://purl.org/dc/terms/hasVersion
DCIdentifier
Description
This class models an DublinCore 'identifier' element
Format
 R6Class object.
Value
Object of  R6Class for modelling an Dublin Core 'identifier' element
Super classes
atom4R::atom4RLogger -> atom4R::AtomAbstractObject -> atom4R::DCElement -> DCIdentifier
Methods
Public methods
Inherited methods
- atom4R::atom4RLogger$ERROR()
- atom4R::atom4RLogger$INFO()
- atom4R::atom4RLogger$WARN()
- atom4R::atom4RLogger$logger()
- atom4R::AtomAbstractObject$addListElement()
- atom4R::AtomAbstractObject$contains()
- atom4R::AtomAbstractObject$createElement()
- atom4R::AtomAbstractObject$decode()
- atom4R::AtomAbstractObject$delListElement()
- atom4R::AtomAbstractObject$encode()
- atom4R::AtomAbstractObject$getClass()
- atom4R::AtomAbstractObject$getClassName()
- atom4R::AtomAbstractObject$getNamespace()
- atom4R::AtomAbstractObject$getNamespaceDefinition()
- atom4R::AtomAbstractObject$getRootElement()
- atom4R::AtomAbstractObject$getXmlElement()
- atom4R::AtomAbstractObject$isDocument()
- atom4R::AtomAbstractObject$isFieldInheritedFrom()
- atom4R::AtomAbstractObject$print()
- atom4R::AtomAbstractObject$save()
- atom4R::AtomAbstractObject$setIsDocument()
- atom4R::AtomAbstractObject$validate()
Method new()
This method is used to create an Dublin core 'identifier' element.
Use dc to TRUE to use Dublin core namespace instead of DC terms.
Usage
DCIdentifier$new(xml = NULL, term = NULL, value = NULL, dc = FALSE)
Arguments
- xml
- object of class XMLInternalNode-class from XML 
- term
- term 
- value
- value 
- dc
- use DC namespace? 
Method clone()
The objects of this class are cloneable with this method.
Usage
DCIdentifier$clone(deep = FALSE)
Arguments
- deep
- Whether to make a deep clone. 
References
Dublin Core Metadata Initiative. https://www.dublincore.org/specifications/dublin-core/dcmi-terms/terms/identifier
DCInstructionalMethod
Description
This class models an DublinCore 'instructionalMethod' element
Format
 R6Class object.
Value
Object of  R6Class for modelling an Dublin Core 'instructionalMethod' element
Super classes
atom4R::atom4RLogger -> atom4R::AtomAbstractObject -> atom4R::DCElement -> DCInstructionalMethod
Methods
Public methods
Inherited methods
- atom4R::atom4RLogger$ERROR()
- atom4R::atom4RLogger$INFO()
- atom4R::atom4RLogger$WARN()
- atom4R::atom4RLogger$logger()
- atom4R::AtomAbstractObject$addListElement()
- atom4R::AtomAbstractObject$contains()
- atom4R::AtomAbstractObject$createElement()
- atom4R::AtomAbstractObject$decode()
- atom4R::AtomAbstractObject$delListElement()
- atom4R::AtomAbstractObject$encode()
- atom4R::AtomAbstractObject$getClass()
- atom4R::AtomAbstractObject$getClassName()
- atom4R::AtomAbstractObject$getNamespace()
- atom4R::AtomAbstractObject$getNamespaceDefinition()
- atom4R::AtomAbstractObject$getRootElement()
- atom4R::AtomAbstractObject$getXmlElement()
- atom4R::AtomAbstractObject$isDocument()
- atom4R::AtomAbstractObject$isFieldInheritedFrom()
- atom4R::AtomAbstractObject$print()
- atom4R::AtomAbstractObject$save()
- atom4R::AtomAbstractObject$setIsDocument()
- atom4R::AtomAbstractObject$validate()
Method new()
Initializes an object of class DCInstructionalMethod
Usage
DCInstructionalMethod$new(xml = NULL, value = NULL)
Arguments
- xml
- object of class XMLInternalNode-class from XML 
- value
- value 
Method clone()
The objects of this class are cloneable with this method.
Usage
DCInstructionalMethod$clone(deep = FALSE)
Arguments
- deep
- Whether to make a deep clone. 
References
Dublin Core Metadata Initiative. https://www.dublincore.org/specifications/dublin-core/dcmi-terms/terms/instructionalMethod
DCIsPartOf
Description
This class models an DublinCore 'isPartOf' element
Format
 R6Class object.
Value
Object of  R6Class for modelling an Dublin Core Terms 'isPartOf' element
Super classes
atom4R::atom4RLogger -> atom4R::AtomAbstractObject -> atom4R::DCElement -> DCIsPartOf
Methods
Public methods
Inherited methods
- atom4R::atom4RLogger$ERROR()
- atom4R::atom4RLogger$INFO()
- atom4R::atom4RLogger$WARN()
- atom4R::atom4RLogger$logger()
- atom4R::AtomAbstractObject$addListElement()
- atom4R::AtomAbstractObject$contains()
- atom4R::AtomAbstractObject$createElement()
- atom4R::AtomAbstractObject$decode()
- atom4R::AtomAbstractObject$delListElement()
- atom4R::AtomAbstractObject$encode()
- atom4R::AtomAbstractObject$getClass()
- atom4R::AtomAbstractObject$getClassName()
- atom4R::AtomAbstractObject$getNamespace()
- atom4R::AtomAbstractObject$getNamespaceDefinition()
- atom4R::AtomAbstractObject$getRootElement()
- atom4R::AtomAbstractObject$getXmlElement()
- atom4R::AtomAbstractObject$isDocument()
- atom4R::AtomAbstractObject$isFieldInheritedFrom()
- atom4R::AtomAbstractObject$print()
- atom4R::AtomAbstractObject$save()
- atom4R::AtomAbstractObject$setIsDocument()
- atom4R::AtomAbstractObject$validate()
Method new()
This method is used to create an Dublin core 'isPartOf' element.
Use dc to TRUE to use Dublin core namespace instead of DC terms.
Usage
DCIsPartOf$new(xml = NULL, value = NULL, dc = FALSE)
Arguments
- xml
- object of class XMLInternalNode-class from XML 
- value
- value 
- dc
- use DC namespace? 
Method clone()
The objects of this class are cloneable with this method.
Usage
DCIsPartOf$clone(deep = FALSE)
Arguments
- deep
- Whether to make a deep clone. 
References
Dublin Core Metadata Initiative. https://www.dublincore.org/specifications/dublin-core/dcmi-terms/#http://purl.org/dc/terms/isPartOf
DCIsReferencedBy
Description
This class models an DublinCore 'isReferencedBy' element
Format
 R6Class object.
Value
Object of  R6Class for modelling an Dublin Core Terms 'isReferencedBy' element
Super classes
atom4R::atom4RLogger -> atom4R::AtomAbstractObject -> atom4R::DCElement -> DCIsReferencedBy
Methods
Public methods
Inherited methods
- atom4R::atom4RLogger$ERROR()
- atom4R::atom4RLogger$INFO()
- atom4R::atom4RLogger$WARN()
- atom4R::atom4RLogger$logger()
- atom4R::AtomAbstractObject$addListElement()
- atom4R::AtomAbstractObject$contains()
- atom4R::AtomAbstractObject$createElement()
- atom4R::AtomAbstractObject$decode()
- atom4R::AtomAbstractObject$delListElement()
- atom4R::AtomAbstractObject$encode()
- atom4R::AtomAbstractObject$getClass()
- atom4R::AtomAbstractObject$getClassName()
- atom4R::AtomAbstractObject$getNamespace()
- atom4R::AtomAbstractObject$getNamespaceDefinition()
- atom4R::AtomAbstractObject$getRootElement()
- atom4R::AtomAbstractObject$getXmlElement()
- atom4R::AtomAbstractObject$isDocument()
- atom4R::AtomAbstractObject$isFieldInheritedFrom()
- atom4R::AtomAbstractObject$print()
- atom4R::AtomAbstractObject$save()
- atom4R::AtomAbstractObject$setIsDocument()
- atom4R::AtomAbstractObject$validate()
Method new()
This method is used to create an Dublin core 'isReferencedBy' element.
Use dc to TRUE to use Dublin core namespace instead of DC terms.
Usage
DCIsReferencedBy$new(xml = NULL, value = NULL, dc = FALSE)
Arguments
- xml
- object of class XMLInternalNode-class from XML 
- value
- value 
- dc
- use DC namespace? 
Method clone()
The objects of this class are cloneable with this method.
Usage
DCIsReferencedBy$clone(deep = FALSE)
Arguments
- deep
- Whether to make a deep clone. 
References
Dublin Core Metadata Initiative. https://www.dublincore.org/specifications/dublin-core/dcmi-terms/#http://purl.org/dc/terms/isReferencedBy
DCIsReplacedBy
Description
This class models an DublinCore 'isReplacedBy' element
Format
 R6Class object.
Value
Object of  R6Class for modelling an Dublin Core Terms 'isReplacedBy' element
Super classes
atom4R::atom4RLogger -> atom4R::AtomAbstractObject -> atom4R::DCElement -> DCIsReplacedBy
Methods
Public methods
Inherited methods
- atom4R::atom4RLogger$ERROR()
- atom4R::atom4RLogger$INFO()
- atom4R::atom4RLogger$WARN()
- atom4R::atom4RLogger$logger()
- atom4R::AtomAbstractObject$addListElement()
- atom4R::AtomAbstractObject$contains()
- atom4R::AtomAbstractObject$createElement()
- atom4R::AtomAbstractObject$decode()
- atom4R::AtomAbstractObject$delListElement()
- atom4R::AtomAbstractObject$encode()
- atom4R::AtomAbstractObject$getClass()
- atom4R::AtomAbstractObject$getClassName()
- atom4R::AtomAbstractObject$getNamespace()
- atom4R::AtomAbstractObject$getNamespaceDefinition()
- atom4R::AtomAbstractObject$getRootElement()
- atom4R::AtomAbstractObject$getXmlElement()
- atom4R::AtomAbstractObject$isDocument()
- atom4R::AtomAbstractObject$isFieldInheritedFrom()
- atom4R::AtomAbstractObject$print()
- atom4R::AtomAbstractObject$save()
- atom4R::AtomAbstractObject$setIsDocument()
- atom4R::AtomAbstractObject$validate()
Method new()
This method is used to create an Dublin core 'isReplacedBy' element.
Use dc to TRUE to use Dublin core namespace instead of DC terms.
Usage
DCIsReplacedBy$new(xml = NULL, value = NULL, dc = FALSE)
Arguments
- xml
- object of class XMLInternalNode-class from XML 
- value
- value 
- dc
- use DC namespace? 
Method clone()
The objects of this class are cloneable with this method.
Usage
DCIsReplacedBy$clone(deep = FALSE)
Arguments
- deep
- Whether to make a deep clone. 
References
Dublin Core Metadata Initiative. https://www.dublincore.org/specifications/dublin-core/dcmi-terms/#http://purl.org/dc/terms/isReplacedBy
DCIsRequiredBy
Description
This class models an DublinCore 'isRequiredBy' element
Format
 R6Class object.
Value
Object of  R6Class for modelling an Dublin Core Terms 'isRequiredBy' element
Super classes
atom4R::atom4RLogger -> atom4R::AtomAbstractObject -> atom4R::DCElement -> DCIsRequiredBy
Methods
Public methods
Inherited methods
- atom4R::atom4RLogger$ERROR()
- atom4R::atom4RLogger$INFO()
- atom4R::atom4RLogger$WARN()
- atom4R::atom4RLogger$logger()
- atom4R::AtomAbstractObject$addListElement()
- atom4R::AtomAbstractObject$contains()
- atom4R::AtomAbstractObject$createElement()
- atom4R::AtomAbstractObject$decode()
- atom4R::AtomAbstractObject$delListElement()
- atom4R::AtomAbstractObject$encode()
- atom4R::AtomAbstractObject$getClass()
- atom4R::AtomAbstractObject$getClassName()
- atom4R::AtomAbstractObject$getNamespace()
- atom4R::AtomAbstractObject$getNamespaceDefinition()
- atom4R::AtomAbstractObject$getRootElement()
- atom4R::AtomAbstractObject$getXmlElement()
- atom4R::AtomAbstractObject$isDocument()
- atom4R::AtomAbstractObject$isFieldInheritedFrom()
- atom4R::AtomAbstractObject$print()
- atom4R::AtomAbstractObject$save()
- atom4R::AtomAbstractObject$setIsDocument()
- atom4R::AtomAbstractObject$validate()
Method new()
This method is used to create an Dublin core 'isRequiredBy' element.
Use dc to TRUE to use Dublin core namespace instead of DC terms.
Usage
DCIsRequiredBy$new(xml = NULL, value = NULL, dc = FALSE)
Arguments
- xml
- object of class XMLInternalNode-class from XML 
- value
- value 
- dc
- use DC namespace? 
Method clone()
The objects of this class are cloneable with this method.
Usage
DCIsRequiredBy$clone(deep = FALSE)
Arguments
- deep
- Whether to make a deep clone. 
References
Dublin Core Metadata Initiative. https://www.dublincore.org/specifications/dublin-core/dcmi-terms/#http://purl.org/dc/terms/isRequiredBy
DCIsVersionOf
Description
This class models an DublinCore 'isVersionOf' element
Format
 R6Class object.
Value
Object of  R6Class for modelling an Dublin Core Terms 'isVersionOf' element
Super classes
atom4R::atom4RLogger -> atom4R::AtomAbstractObject -> atom4R::DCElement -> DCIsVersionOf
Methods
Public methods
Inherited methods
- atom4R::atom4RLogger$ERROR()
- atom4R::atom4RLogger$INFO()
- atom4R::atom4RLogger$WARN()
- atom4R::atom4RLogger$logger()
- atom4R::AtomAbstractObject$addListElement()
- atom4R::AtomAbstractObject$contains()
- atom4R::AtomAbstractObject$createElement()
- atom4R::AtomAbstractObject$decode()
- atom4R::AtomAbstractObject$delListElement()
- atom4R::AtomAbstractObject$encode()
- atom4R::AtomAbstractObject$getClass()
- atom4R::AtomAbstractObject$getClassName()
- atom4R::AtomAbstractObject$getNamespace()
- atom4R::AtomAbstractObject$getNamespaceDefinition()
- atom4R::AtomAbstractObject$getRootElement()
- atom4R::AtomAbstractObject$getXmlElement()
- atom4R::AtomAbstractObject$isDocument()
- atom4R::AtomAbstractObject$isFieldInheritedFrom()
- atom4R::AtomAbstractObject$print()
- atom4R::AtomAbstractObject$save()
- atom4R::AtomAbstractObject$setIsDocument()
- atom4R::AtomAbstractObject$validate()
Method new()
This method is used to create an Dublin core 'isVersionOf' element.
Use dc to TRUE to use Dublin core namespace instead of DC terms.
Usage
DCIsVersionOf$new(xml = NULL, value = NULL, dc = FALSE)
Arguments
- xml
- object of class XMLInternalNode-class from XML 
- value
- value 
- dc
- use DC namespace? 
Method clone()
The objects of this class are cloneable with this method.
Usage
DCIsVersionOf$clone(deep = FALSE)
Arguments
- deep
- Whether to make a deep clone. 
References
Dublin Core Metadata Initiative. https://www.dublincore.org/specifications/dublin-core/dcmi-terms/#http://purl.org/dc/terms/isVersionOf
DCIssued
Description
This class models an DublinCore 'issued' element
Format
 R6Class object.
Value
Object of  R6Class for modelling an Dublin Core Terms 'issued' element
Super classes
atom4R::atom4RLogger -> atom4R::AtomAbstractObject -> atom4R::DCElement -> atom4R::DCDate -> DCIssued
Methods
Public methods
Inherited methods
- atom4R::atom4RLogger$ERROR()
- atom4R::atom4RLogger$INFO()
- atom4R::atom4RLogger$WARN()
- atom4R::atom4RLogger$logger()
- atom4R::AtomAbstractObject$addListElement()
- atom4R::AtomAbstractObject$contains()
- atom4R::AtomAbstractObject$createElement()
- atom4R::AtomAbstractObject$decode()
- atom4R::AtomAbstractObject$delListElement()
- atom4R::AtomAbstractObject$encode()
- atom4R::AtomAbstractObject$getClass()
- atom4R::AtomAbstractObject$getClassName()
- atom4R::AtomAbstractObject$getNamespace()
- atom4R::AtomAbstractObject$getNamespaceDefinition()
- atom4R::AtomAbstractObject$getRootElement()
- atom4R::AtomAbstractObject$getXmlElement()
- atom4R::AtomAbstractObject$isDocument()
- atom4R::AtomAbstractObject$isFieldInheritedFrom()
- atom4R::AtomAbstractObject$print()
- atom4R::AtomAbstractObject$save()
- atom4R::AtomAbstractObject$setIsDocument()
- atom4R::AtomAbstractObject$validate()
Method new()
Initializes an object of class DCIssued
Usage
DCIssued$new(xml = NULL, value = NULL)
Arguments
- xml
- object of class XMLInternalNode-class from XML 
- value
- value 
Method clone()
The objects of this class are cloneable with this method.
Usage
DCIssued$clone(deep = FALSE)
Arguments
- deep
- Whether to make a deep clone. 
References
Dublin Core Metadata Initiative. https://www.dublincore.org/specifications/dublin-core/dcmi-terms/terms/issued
DCLanguage
Description
This class models an DublinCore 'language' element
Format
 R6Class object.
Value
Object of  R6Class for modelling an Dublin Core Terms 'language' element
Super classes
atom4R::atom4RLogger -> atom4R::AtomAbstractObject -> atom4R::DCElement -> DCLanguage
Methods
Public methods
Inherited methods
- atom4R::atom4RLogger$ERROR()
- atom4R::atom4RLogger$INFO()
- atom4R::atom4RLogger$WARN()
- atom4R::atom4RLogger$logger()
- atom4R::AtomAbstractObject$addListElement()
- atom4R::AtomAbstractObject$contains()
- atom4R::AtomAbstractObject$createElement()
- atom4R::AtomAbstractObject$decode()
- atom4R::AtomAbstractObject$delListElement()
- atom4R::AtomAbstractObject$encode()
- atom4R::AtomAbstractObject$getClass()
- atom4R::AtomAbstractObject$getClassName()
- atom4R::AtomAbstractObject$getNamespace()
- atom4R::AtomAbstractObject$getNamespaceDefinition()
- atom4R::AtomAbstractObject$getRootElement()
- atom4R::AtomAbstractObject$getXmlElement()
- atom4R::AtomAbstractObject$isDocument()
- atom4R::AtomAbstractObject$isFieldInheritedFrom()
- atom4R::AtomAbstractObject$print()
- atom4R::AtomAbstractObject$save()
- atom4R::AtomAbstractObject$setIsDocument()
- atom4R::AtomAbstractObject$validate()
Method new()
This method is used to create an Dublin core 'language' element.
Use dc to TRUE to use Dublin core namespace instead of DC terms.
Usage
DCLanguage$new(xml = NULL, value = NULL, dc = FALSE)
Arguments
- xml
- object of class XMLInternalNode-class from XML 
- value
- value 
- dc
- use DC namespace? 
Method clone()
The objects of this class are cloneable with this method.
Usage
DCLanguage$clone(deep = FALSE)
Arguments
- deep
- Whether to make a deep clone. 
References
Dublin Core Metadata Initiative. https://www.dublincore.org/specifications/dublin-core/dcmi-terms/terms/language
DCLicense
Description
This class models an DublinCore 'license' element
Format
 R6Class object.
Value
Object of  R6Class for modelling an Dublin Core Terms 'license' element
Super classes
atom4R::atom4RLogger -> atom4R::AtomAbstractObject -> atom4R::DCElement -> atom4R::DCRights -> DCLicense
Methods
Public methods
Inherited methods
- atom4R::atom4RLogger$ERROR()
- atom4R::atom4RLogger$INFO()
- atom4R::atom4RLogger$WARN()
- atom4R::atom4RLogger$logger()
- atom4R::AtomAbstractObject$addListElement()
- atom4R::AtomAbstractObject$contains()
- atom4R::AtomAbstractObject$createElement()
- atom4R::AtomAbstractObject$decode()
- atom4R::AtomAbstractObject$delListElement()
- atom4R::AtomAbstractObject$encode()
- atom4R::AtomAbstractObject$getClass()
- atom4R::AtomAbstractObject$getClassName()
- atom4R::AtomAbstractObject$getNamespace()
- atom4R::AtomAbstractObject$getNamespaceDefinition()
- atom4R::AtomAbstractObject$getRootElement()
- atom4R::AtomAbstractObject$getXmlElement()
- atom4R::AtomAbstractObject$isDocument()
- atom4R::AtomAbstractObject$isFieldInheritedFrom()
- atom4R::AtomAbstractObject$print()
- atom4R::AtomAbstractObject$save()
- atom4R::AtomAbstractObject$setIsDocument()
- atom4R::AtomAbstractObject$validate()
Method new()
Initializes an object of class DCLicense
Usage
DCLicense$new(xml = NULL, value = NULL)
Arguments
- xml
- object of class XMLInternalNode-class from XML 
- value
- value 
Method clone()
The objects of this class are cloneable with this method.
Usage
DCLicense$clone(deep = FALSE)
Arguments
- deep
- Whether to make a deep clone. 
References
Dublin Core Metadata Initiative. https://www.dublincore.org/specifications/dublin-core/dcmi-terms/terms/license
DCMI Vocabulary class
Description
This class models an DCMI Vocabulary
Format
 R6Class object.
Details
DCMIVocabulary
Value
Object of  R6Class for modelling an Dublin Core element
Public fields
- id
- id 
- doc
- doc 
- representation
- representation 
- data
- data 
Methods
Public methods
Method new()
This method is used to read a DCMI vocabulary RDF doc. The format corresponds to
the RDF format as used by rdflib rdf_parse function.
Usage
DCMIVocabulary$new(id, doc, format, fetch = TRUE)
Arguments
- id
- id 
- doc
- doc 
- format
- format 
- fetch
- fetch 
Method fetch()
Runs a Sparql query over the RDF vocabulary to fetch the vocabulary content.
Usage
DCMIVocabulary$fetch()
Method clone()
The objects of this class are cloneable with this method.
Usage
DCMIVocabulary$clone(deep = FALSE)
Arguments
- deep
- Whether to make a deep clone. 
Author(s)
Emmanuel Blondel <emmanuel.blondel1@gmail.com>
DCMediator
Description
This class models an DublinCore 'mediator' element
Format
 R6Class object.
Value
Object of  R6Class for modelling an Dublin Core Terms 'mediator' element
Super classes
atom4R::atom4RLogger -> atom4R::AtomAbstractObject -> atom4R::DCElement -> atom4R::DCAudience -> DCMediator
Methods
Public methods
Inherited methods
- atom4R::atom4RLogger$ERROR()
- atom4R::atom4RLogger$INFO()
- atom4R::atom4RLogger$WARN()
- atom4R::atom4RLogger$logger()
- atom4R::AtomAbstractObject$addListElement()
- atom4R::AtomAbstractObject$contains()
- atom4R::AtomAbstractObject$createElement()
- atom4R::AtomAbstractObject$decode()
- atom4R::AtomAbstractObject$delListElement()
- atom4R::AtomAbstractObject$encode()
- atom4R::AtomAbstractObject$getClass()
- atom4R::AtomAbstractObject$getClassName()
- atom4R::AtomAbstractObject$getNamespace()
- atom4R::AtomAbstractObject$getNamespaceDefinition()
- atom4R::AtomAbstractObject$getRootElement()
- atom4R::AtomAbstractObject$getXmlElement()
- atom4R::AtomAbstractObject$isDocument()
- atom4R::AtomAbstractObject$isFieldInheritedFrom()
- atom4R::AtomAbstractObject$print()
- atom4R::AtomAbstractObject$save()
- atom4R::AtomAbstractObject$setIsDocument()
- atom4R::AtomAbstractObject$validate()
Method new()
Initializes an object of class DCMediator
Usage
DCMediator$new(xml = NULL, value = NULL)
Arguments
- xml
- object of class XMLInternalNode-class from XML 
- value
- value 
Method clone()
The objects of this class are cloneable with this method.
Usage
DCMediator$clone(deep = FALSE)
Arguments
- deep
- Whether to make a deep clone. 
References
Dublin Core Metadata Initiative. https://www.dublincore.org/specifications/dublin-core/dcmi-terms/terms/mediator
DCMedium
Description
This class models an DublinCore 'medium' element
Format
 R6Class object.
Value
Object of  R6Class for modelling an Dublin Core Terms 'medium' element
Super classes
atom4R::atom4RLogger -> atom4R::AtomAbstractObject -> atom4R::DCElement -> atom4R::DCFormat -> DCMedium
Methods
Public methods
Inherited methods
- atom4R::atom4RLogger$ERROR()
- atom4R::atom4RLogger$INFO()
- atom4R::atom4RLogger$WARN()
- atom4R::atom4RLogger$logger()
- atom4R::AtomAbstractObject$addListElement()
- atom4R::AtomAbstractObject$contains()
- atom4R::AtomAbstractObject$createElement()
- atom4R::AtomAbstractObject$decode()
- atom4R::AtomAbstractObject$delListElement()
- atom4R::AtomAbstractObject$encode()
- atom4R::AtomAbstractObject$getClass()
- atom4R::AtomAbstractObject$getClassName()
- atom4R::AtomAbstractObject$getNamespace()
- atom4R::AtomAbstractObject$getNamespaceDefinition()
- atom4R::AtomAbstractObject$getRootElement()
- atom4R::AtomAbstractObject$getXmlElement()
- atom4R::AtomAbstractObject$isDocument()
- atom4R::AtomAbstractObject$isFieldInheritedFrom()
- atom4R::AtomAbstractObject$print()
- atom4R::AtomAbstractObject$save()
- atom4R::AtomAbstractObject$setIsDocument()
- atom4R::AtomAbstractObject$validate()
Method new()
Initializes an object of class DCMedium
Usage
DCMedium$new(xml = NULL, value = NULL)
Arguments
- xml
- object of class XMLInternalNode-class from XML 
- value
- value 
Method clone()
The objects of this class are cloneable with this method.
Usage
DCMedium$clone(deep = FALSE)
Arguments
- deep
- Whether to make a deep clone. 
References
Dublin Core Metadata Initiative. https://www.dublincore.org/specifications/dublin-core/dcmi-terms/terms/medium
DCModified
Description
This class models an DublinCore 'modified' element
Format
 R6Class object.
Value
Object of  R6Class for modelling an Dublin Core Terms 'modified' element
Super classes
atom4R::atom4RLogger -> atom4R::AtomAbstractObject -> atom4R::DCElement -> atom4R::DCDate -> DCModified
Methods
Public methods
Inherited methods
- atom4R::atom4RLogger$ERROR()
- atom4R::atom4RLogger$INFO()
- atom4R::atom4RLogger$WARN()
- atom4R::atom4RLogger$logger()
- atom4R::AtomAbstractObject$addListElement()
- atom4R::AtomAbstractObject$contains()
- atom4R::AtomAbstractObject$createElement()
- atom4R::AtomAbstractObject$decode()
- atom4R::AtomAbstractObject$delListElement()
- atom4R::AtomAbstractObject$encode()
- atom4R::AtomAbstractObject$getClass()
- atom4R::AtomAbstractObject$getClassName()
- atom4R::AtomAbstractObject$getNamespace()
- atom4R::AtomAbstractObject$getNamespaceDefinition()
- atom4R::AtomAbstractObject$getRootElement()
- atom4R::AtomAbstractObject$getXmlElement()
- atom4R::AtomAbstractObject$isDocument()
- atom4R::AtomAbstractObject$isFieldInheritedFrom()
- atom4R::AtomAbstractObject$print()
- atom4R::AtomAbstractObject$save()
- atom4R::AtomAbstractObject$setIsDocument()
- atom4R::AtomAbstractObject$validate()
Method new()
Initializes an object of class DCModified
Usage
DCModified$new(xml = NULL, value = NULL)
Arguments
- xml
- object of class XMLInternalNode-class from XML 
- value
- value 
Method clone()
The objects of this class are cloneable with this method.
Usage
DCModified$clone(deep = FALSE)
Arguments
- deep
- Whether to make a deep clone. 
References
Dublin Core Metadata Initiative. https://www.dublincore.org/specifications/dublin-core/dcmi-terms/terms/modified
DCProvenance
Description
This class models an DublinCore 'provenance' element
Format
 R6Class object.
Value
Object of  R6Class for modelling an Dublin Core Terms 'provenance' element
Super classes
atom4R::atom4RLogger -> atom4R::AtomAbstractObject -> atom4R::DCElement -> DCProvenance
Methods
Public methods
Inherited methods
- atom4R::atom4RLogger$ERROR()
- atom4R::atom4RLogger$INFO()
- atom4R::atom4RLogger$WARN()
- atom4R::atom4RLogger$logger()
- atom4R::AtomAbstractObject$addListElement()
- atom4R::AtomAbstractObject$contains()
- atom4R::AtomAbstractObject$createElement()
- atom4R::AtomAbstractObject$decode()
- atom4R::AtomAbstractObject$delListElement()
- atom4R::AtomAbstractObject$encode()
- atom4R::AtomAbstractObject$getClass()
- atom4R::AtomAbstractObject$getClassName()
- atom4R::AtomAbstractObject$getNamespace()
- atom4R::AtomAbstractObject$getNamespaceDefinition()
- atom4R::AtomAbstractObject$getRootElement()
- atom4R::AtomAbstractObject$getXmlElement()
- atom4R::AtomAbstractObject$isDocument()
- atom4R::AtomAbstractObject$isFieldInheritedFrom()
- atom4R::AtomAbstractObject$print()
- atom4R::AtomAbstractObject$save()
- atom4R::AtomAbstractObject$setIsDocument()
- atom4R::AtomAbstractObject$validate()
Method new()
Initializes an object of class DCProvenance
Usage
DCProvenance$new(xml = NULL, value = NULL)
Arguments
- xml
- object of class XMLInternalNode-class from XML 
- value
- value 
Method clone()
The objects of this class are cloneable with this method.
Usage
DCProvenance$clone(deep = FALSE)
Arguments
- deep
- Whether to make a deep clone. 
References
Dublin Core Metadata Initiative. https://www.dublincore.org/specifications/dublin-core/dcmi-terms/terms/provenance
DCPublisher
Description
This class models an DublinCore 'publisher' element
Format
 R6Class object.
Value
Object of  R6Class for modelling an Dublin Core Terms 'publisher' element
Super classes
atom4R::atom4RLogger -> atom4R::AtomAbstractObject -> atom4R::DCElement -> DCPublisher
Methods
Public methods
Inherited methods
- atom4R::atom4RLogger$ERROR()
- atom4R::atom4RLogger$INFO()
- atom4R::atom4RLogger$WARN()
- atom4R::atom4RLogger$logger()
- atom4R::AtomAbstractObject$addListElement()
- atom4R::AtomAbstractObject$contains()
- atom4R::AtomAbstractObject$createElement()
- atom4R::AtomAbstractObject$decode()
- atom4R::AtomAbstractObject$delListElement()
- atom4R::AtomAbstractObject$encode()
- atom4R::AtomAbstractObject$getClass()
- atom4R::AtomAbstractObject$getClassName()
- atom4R::AtomAbstractObject$getNamespace()
- atom4R::AtomAbstractObject$getNamespaceDefinition()
- atom4R::AtomAbstractObject$getRootElement()
- atom4R::AtomAbstractObject$getXmlElement()
- atom4R::AtomAbstractObject$isDocument()
- atom4R::AtomAbstractObject$isFieldInheritedFrom()
- atom4R::AtomAbstractObject$print()
- atom4R::AtomAbstractObject$save()
- atom4R::AtomAbstractObject$setIsDocument()
- atom4R::AtomAbstractObject$validate()
Method new()
This method is used to create an Dublin core 'publisher' element.
Use dc to TRUE to use Dublin core namespace instead of DC terms.
Usage
DCPublisher$new(xml = NULL, value = NULL, dc = FALSE)
Arguments
- xml
- object of class XMLInternalNode-class from XML 
- value
- value 
- dc
- use DC namespace? 
Method clone()
The objects of this class are cloneable with this method.
Usage
DCPublisher$clone(deep = FALSE)
Arguments
- deep
- Whether to make a deep clone. 
References
Dublin Core Metadata Initiative. https://www.dublincore.org/specifications/dublin-core/dcmi-terms/terms/publisher
DCReferences
Description
This class models an DublinCore 'references' element
Format
 R6Class object.
Value
Object of  R6Class for modelling an Dublin Core Terms 'references' element
Super classes
atom4R::atom4RLogger -> atom4R::AtomAbstractObject -> atom4R::DCElement -> atom4R::DCRelation -> DCReferences
Methods
Public methods
Inherited methods
- atom4R::atom4RLogger$ERROR()
- atom4R::atom4RLogger$INFO()
- atom4R::atom4RLogger$WARN()
- atom4R::atom4RLogger$logger()
- atom4R::AtomAbstractObject$addListElement()
- atom4R::AtomAbstractObject$contains()
- atom4R::AtomAbstractObject$createElement()
- atom4R::AtomAbstractObject$decode()
- atom4R::AtomAbstractObject$delListElement()
- atom4R::AtomAbstractObject$encode()
- atom4R::AtomAbstractObject$getClass()
- atom4R::AtomAbstractObject$getClassName()
- atom4R::AtomAbstractObject$getNamespace()
- atom4R::AtomAbstractObject$getNamespaceDefinition()
- atom4R::AtomAbstractObject$getRootElement()
- atom4R::AtomAbstractObject$getXmlElement()
- atom4R::AtomAbstractObject$isDocument()
- atom4R::AtomAbstractObject$isFieldInheritedFrom()
- atom4R::AtomAbstractObject$print()
- atom4R::AtomAbstractObject$save()
- atom4R::AtomAbstractObject$setIsDocument()
- atom4R::AtomAbstractObject$validate()
Method new()
Initializes an object of class DCReferences
Usage
DCReferences$new(xml = NULL, value = NULL)
Arguments
- xml
- object of class XMLInternalNode-class from XML 
- value
- value 
Method clone()
The objects of this class are cloneable with this method.
Usage
DCReferences$clone(deep = FALSE)
Arguments
- deep
- Whether to make a deep clone. 
References
Dublin Core Metadata Initiative. https://www.dublincore.org/specifications/dublin-core/dcmi-terms/terms/references
DCRelation
Description
This class models an DublinCore 'relation' element
Format
 R6Class object.
Value
Object of  R6Class for modelling an Dublin Core Terms 'relation' element
Super classes
atom4R::atom4RLogger -> atom4R::AtomAbstractObject -> atom4R::DCElement -> DCRelation
Methods
Public methods
Inherited methods
- atom4R::atom4RLogger$ERROR()
- atom4R::atom4RLogger$INFO()
- atom4R::atom4RLogger$WARN()
- atom4R::atom4RLogger$logger()
- atom4R::AtomAbstractObject$addListElement()
- atom4R::AtomAbstractObject$contains()
- atom4R::AtomAbstractObject$createElement()
- atom4R::AtomAbstractObject$decode()
- atom4R::AtomAbstractObject$delListElement()
- atom4R::AtomAbstractObject$encode()
- atom4R::AtomAbstractObject$getClass()
- atom4R::AtomAbstractObject$getClassName()
- atom4R::AtomAbstractObject$getNamespace()
- atom4R::AtomAbstractObject$getNamespaceDefinition()
- atom4R::AtomAbstractObject$getRootElement()
- atom4R::AtomAbstractObject$getXmlElement()
- atom4R::AtomAbstractObject$isDocument()
- atom4R::AtomAbstractObject$isFieldInheritedFrom()
- atom4R::AtomAbstractObject$print()
- atom4R::AtomAbstractObject$save()
- atom4R::AtomAbstractObject$setIsDocument()
- atom4R::AtomAbstractObject$validate()
Method new()
This method is used to create an Dublin core 'relation' element.
Use dc to TRUE to use Dublin core namespace instead of DC terms.
Usage
DCRelation$new(xml = NULL, term = NULL, value = NULL, dc = FALSE)
Arguments
- xml
- object of class XMLInternalNode-class from XML 
- term
- term 
- value
- value 
- dc
- use DC namespace? 
Method clone()
The objects of this class are cloneable with this method.
Usage
DCRelation$clone(deep = FALSE)
Arguments
- deep
- Whether to make a deep clone. 
References
Dublin Core Metadata Initiative. https://www.dublincore.org/specifications/dublin-core/dcmi-terms/terms/relation
DCReplaces
Description
This class models an DublinCore 'replaces' element
Format
 R6Class object.
Value
Object of  R6Class for modelling an Dublin Core Terms 'replaces' element
Super classes
atom4R::atom4RLogger -> atom4R::AtomAbstractObject -> atom4R::DCElement -> atom4R::DCRelation -> DCReplaces
Methods
Public methods
Inherited methods
- atom4R::atom4RLogger$ERROR()
- atom4R::atom4RLogger$INFO()
- atom4R::atom4RLogger$WARN()
- atom4R::atom4RLogger$logger()
- atom4R::AtomAbstractObject$addListElement()
- atom4R::AtomAbstractObject$contains()
- atom4R::AtomAbstractObject$createElement()
- atom4R::AtomAbstractObject$decode()
- atom4R::AtomAbstractObject$delListElement()
- atom4R::AtomAbstractObject$encode()
- atom4R::AtomAbstractObject$getClass()
- atom4R::AtomAbstractObject$getClassName()
- atom4R::AtomAbstractObject$getNamespace()
- atom4R::AtomAbstractObject$getNamespaceDefinition()
- atom4R::AtomAbstractObject$getRootElement()
- atom4R::AtomAbstractObject$getXmlElement()
- atom4R::AtomAbstractObject$isDocument()
- atom4R::AtomAbstractObject$isFieldInheritedFrom()
- atom4R::AtomAbstractObject$print()
- atom4R::AtomAbstractObject$save()
- atom4R::AtomAbstractObject$setIsDocument()
- atom4R::AtomAbstractObject$validate()
Method new()
Initializes an object of class DCReplaces
Usage
DCReplaces$new(xml = NULL, value = NULL)
Arguments
- xml
- object of class XMLInternalNode-class from XML 
- value
- value 
Method clone()
The objects of this class are cloneable with this method.
Usage
DCReplaces$clone(deep = FALSE)
Arguments
- deep
- Whether to make a deep clone. 
References
Dublin Core Metadata Initiative. https://www.dublincore.org/specifications/dublin-core/dcmi-terms/terms/replaces
DCRequires
Description
This class models an DublinCore 'requires' element
Format
 R6Class object.
Value
Object of  R6Class for modelling an Dublin Core Terms 'requires' element
Super classes
atom4R::atom4RLogger -> atom4R::AtomAbstractObject -> atom4R::DCElement -> atom4R::DCRelation -> DCRequires
Methods
Public methods
Inherited methods
- atom4R::atom4RLogger$ERROR()
- atom4R::atom4RLogger$INFO()
- atom4R::atom4RLogger$WARN()
- atom4R::atom4RLogger$logger()
- atom4R::AtomAbstractObject$addListElement()
- atom4R::AtomAbstractObject$contains()
- atom4R::AtomAbstractObject$createElement()
- atom4R::AtomAbstractObject$decode()
- atom4R::AtomAbstractObject$delListElement()
- atom4R::AtomAbstractObject$encode()
- atom4R::AtomAbstractObject$getClass()
- atom4R::AtomAbstractObject$getClassName()
- atom4R::AtomAbstractObject$getNamespace()
- atom4R::AtomAbstractObject$getNamespaceDefinition()
- atom4R::AtomAbstractObject$getRootElement()
- atom4R::AtomAbstractObject$getXmlElement()
- atom4R::AtomAbstractObject$isDocument()
- atom4R::AtomAbstractObject$isFieldInheritedFrom()
- atom4R::AtomAbstractObject$print()
- atom4R::AtomAbstractObject$save()
- atom4R::AtomAbstractObject$setIsDocument()
- atom4R::AtomAbstractObject$validate()
Method new()
Initializes an object of class DCRequires
Usage
DCRequires$new(xml = NULL, value = NULL)
Arguments
- xml
- object of class XMLInternalNode-class from XML 
- value
- value 
Method clone()
The objects of this class are cloneable with this method.
Usage
DCRequires$clone(deep = FALSE)
Arguments
- deep
- Whether to make a deep clone. 
References
Dublin Core Metadata Initiative. https://www.dublincore.org/specifications/dublin-core/dcmi-terms/terms/requires
DCRights
Description
This class models an DublinCore 'rights' element
Format
 R6Class object.
Value
Object of  R6Class for modelling an Dublin Core Terms 'rights' element
Super classes
atom4R::atom4RLogger -> atom4R::AtomAbstractObject -> atom4R::DCElement -> DCRights
Methods
Public methods
Inherited methods
- atom4R::atom4RLogger$ERROR()
- atom4R::atom4RLogger$INFO()
- atom4R::atom4RLogger$WARN()
- atom4R::atom4RLogger$logger()
- atom4R::AtomAbstractObject$addListElement()
- atom4R::AtomAbstractObject$contains()
- atom4R::AtomAbstractObject$createElement()
- atom4R::AtomAbstractObject$decode()
- atom4R::AtomAbstractObject$delListElement()
- atom4R::AtomAbstractObject$encode()
- atom4R::AtomAbstractObject$getClass()
- atom4R::AtomAbstractObject$getClassName()
- atom4R::AtomAbstractObject$getNamespace()
- atom4R::AtomAbstractObject$getNamespaceDefinition()
- atom4R::AtomAbstractObject$getRootElement()
- atom4R::AtomAbstractObject$getXmlElement()
- atom4R::AtomAbstractObject$isDocument()
- atom4R::AtomAbstractObject$isFieldInheritedFrom()
- atom4R::AtomAbstractObject$print()
- atom4R::AtomAbstractObject$save()
- atom4R::AtomAbstractObject$setIsDocument()
- atom4R::AtomAbstractObject$validate()
Method new()
This method is used to create an Dublin core 'rights' element.
Use dc to TRUE to use Dublin core namespace instead of DC terms.
Usage
DCRights$new(xml = NULL, term = NULL, value = NULL, dc = FALSE)
Arguments
- xml
- object of class XMLInternalNode-class from XML 
- term
- term 
- value
- value 
- dc
- use DC namespace? 
Method clone()
The objects of this class are cloneable with this method.
Usage
DCRights$clone(deep = FALSE)
Arguments
- deep
- Whether to make a deep clone. 
References
Dublin Core Metadata Initiative. https://www.dublincore.org/specifications/dublin-core/dcmi-terms/terms/rights
DCRightsHolder
Description
This class models an DublinCore 'rightsHolder' element
Format
 R6Class object.
Value
Object of  R6Class for modelling an Dublin Core Terms 'rightsHolder' element
Super classes
atom4R::atom4RLogger -> atom4R::AtomAbstractObject -> atom4R::DCElement -> DCRightsHolder
Methods
Public methods
Inherited methods
- atom4R::atom4RLogger$ERROR()
- atom4R::atom4RLogger$INFO()
- atom4R::atom4RLogger$WARN()
- atom4R::atom4RLogger$logger()
- atom4R::AtomAbstractObject$addListElement()
- atom4R::AtomAbstractObject$contains()
- atom4R::AtomAbstractObject$createElement()
- atom4R::AtomAbstractObject$decode()
- atom4R::AtomAbstractObject$delListElement()
- atom4R::AtomAbstractObject$encode()
- atom4R::AtomAbstractObject$getClass()
- atom4R::AtomAbstractObject$getClassName()
- atom4R::AtomAbstractObject$getNamespace()
- atom4R::AtomAbstractObject$getNamespaceDefinition()
- atom4R::AtomAbstractObject$getRootElement()
- atom4R::AtomAbstractObject$getXmlElement()
- atom4R::AtomAbstractObject$isDocument()
- atom4R::AtomAbstractObject$isFieldInheritedFrom()
- atom4R::AtomAbstractObject$print()
- atom4R::AtomAbstractObject$save()
- atom4R::AtomAbstractObject$setIsDocument()
- atom4R::AtomAbstractObject$validate()
Method new()
Initializes an object of class DCRightsHolder
Usage
DCRightsHolder$new(xml = NULL, value = NULL)
Arguments
- xml
- object of class XMLInternalNode-class from XML 
- value
- value 
Method clone()
The objects of this class are cloneable with this method.
Usage
DCRightsHolder$clone(deep = FALSE)
Arguments
- deep
- Whether to make a deep clone. 
References
Dublin Core Metadata Initiative. https://www.dublincore.org/specifications/dublin-core/dcmi-terms/terms/rightsHolder
DCSource
Description
This class models an DublinCore 'source' element
Format
 R6Class object.
Value
Object of  R6Class for modelling an Dublin Core Terms 'source' element
Super classes
atom4R::atom4RLogger -> atom4R::AtomAbstractObject -> atom4R::DCElement -> atom4R::DCRelation -> DCSource
Methods
Public methods
Inherited methods
- atom4R::atom4RLogger$ERROR()
- atom4R::atom4RLogger$INFO()
- atom4R::atom4RLogger$WARN()
- atom4R::atom4RLogger$logger()
- atom4R::AtomAbstractObject$addListElement()
- atom4R::AtomAbstractObject$contains()
- atom4R::AtomAbstractObject$createElement()
- atom4R::AtomAbstractObject$decode()
- atom4R::AtomAbstractObject$delListElement()
- atom4R::AtomAbstractObject$encode()
- atom4R::AtomAbstractObject$getClass()
- atom4R::AtomAbstractObject$getClassName()
- atom4R::AtomAbstractObject$getNamespace()
- atom4R::AtomAbstractObject$getNamespaceDefinition()
- atom4R::AtomAbstractObject$getRootElement()
- atom4R::AtomAbstractObject$getXmlElement()
- atom4R::AtomAbstractObject$isDocument()
- atom4R::AtomAbstractObject$isFieldInheritedFrom()
- atom4R::AtomAbstractObject$print()
- atom4R::AtomAbstractObject$save()
- atom4R::AtomAbstractObject$setIsDocument()
- atom4R::AtomAbstractObject$validate()
Method new()
This method is used to create an Dublin core 'source' element.
Use dc to TRUE to use Dublin core namespace instead of DC terms.
Usage
DCSource$new(xml = NULL, value = NULL, dc = FALSE)
Arguments
- xml
- object of class XMLInternalNode-class from XML 
- value
- value 
- dc
- use DC namespace? 
Method clone()
The objects of this class are cloneable with this method.
Usage
DCSource$clone(deep = FALSE)
Arguments
- deep
- Whether to make a deep clone. 
References
Dublin Core Metadata Initiative. https://www.dublincore.org/specifications/dublin-core/dcmi-terms/terms/source
DCSpatial
Description
This class models an DublinCore 'spatial' element
Format
 R6Class object.
Value
Object of  R6Class for modelling an Dublin Core Terms 'spatial' element
Super classes
atom4R::atom4RLogger -> atom4R::AtomAbstractObject -> atom4R::DCElement -> atom4R::DCCoverage -> DCSpatial
Methods
Public methods
Inherited methods
- atom4R::atom4RLogger$ERROR()
- atom4R::atom4RLogger$INFO()
- atom4R::atom4RLogger$WARN()
- atom4R::atom4RLogger$logger()
- atom4R::AtomAbstractObject$addListElement()
- atom4R::AtomAbstractObject$contains()
- atom4R::AtomAbstractObject$createElement()
- atom4R::AtomAbstractObject$decode()
- atom4R::AtomAbstractObject$delListElement()
- atom4R::AtomAbstractObject$encode()
- atom4R::AtomAbstractObject$getClass()
- atom4R::AtomAbstractObject$getClassName()
- atom4R::AtomAbstractObject$getNamespace()
- atom4R::AtomAbstractObject$getNamespaceDefinition()
- atom4R::AtomAbstractObject$getRootElement()
- atom4R::AtomAbstractObject$getXmlElement()
- atom4R::AtomAbstractObject$isDocument()
- atom4R::AtomAbstractObject$isFieldInheritedFrom()
- atom4R::AtomAbstractObject$print()
- atom4R::AtomAbstractObject$save()
- atom4R::AtomAbstractObject$setIsDocument()
- atom4R::AtomAbstractObject$validate()
Method new()
Initializes an object of class DCSpatial
Usage
DCSpatial$new(xml = NULL, value = NULL)
Arguments
- xml
- object of class XMLInternalNode-class from XML 
- value
- value 
Method clone()
The objects of this class are cloneable with this method.
Usage
DCSpatial$clone(deep = FALSE)
Arguments
- deep
- Whether to make a deep clone. 
References
Dublin Core Metadata Initiative. https://www.dublincore.org/specifications/dublin-core/dcmi-terms/terms/spatial
DCSubject
Description
This class models an DublinCore 'subject' element
Format
 R6Class object.
Value
Object of  R6Class for modelling an Dublin Core Terms 'subject' element
Super classes
atom4R::atom4RLogger -> atom4R::AtomAbstractObject -> atom4R::DCElement -> DCSubject
Methods
Public methods
Inherited methods
- atom4R::atom4RLogger$ERROR()
- atom4R::atom4RLogger$INFO()
- atom4R::atom4RLogger$WARN()
- atom4R::atom4RLogger$logger()
- atom4R::AtomAbstractObject$addListElement()
- atom4R::AtomAbstractObject$contains()
- atom4R::AtomAbstractObject$createElement()
- atom4R::AtomAbstractObject$decode()
- atom4R::AtomAbstractObject$delListElement()
- atom4R::AtomAbstractObject$encode()
- atom4R::AtomAbstractObject$getClass()
- atom4R::AtomAbstractObject$getClassName()
- atom4R::AtomAbstractObject$getNamespace()
- atom4R::AtomAbstractObject$getNamespaceDefinition()
- atom4R::AtomAbstractObject$getRootElement()
- atom4R::AtomAbstractObject$getXmlElement()
- atom4R::AtomAbstractObject$isDocument()
- atom4R::AtomAbstractObject$isFieldInheritedFrom()
- atom4R::AtomAbstractObject$print()
- atom4R::AtomAbstractObject$save()
- atom4R::AtomAbstractObject$setIsDocument()
- atom4R::AtomAbstractObject$validate()
Method new()
This method is used to create an Dublin core 'subject' element.
Use dc to TRUE to use Dublin core namespace instead of DC terms.
Usage
DCSubject$new(xml = NULL, value = NULL, dc = FALSE)
Arguments
- xml
- object of class XMLInternalNode-class from XML 
- value
- value 
- dc
- use DC namespace? 
Method clone()
The objects of this class are cloneable with this method.
Usage
DCSubject$clone(deep = FALSE)
Arguments
- deep
- Whether to make a deep clone. 
References
Dublin Core Metadata Initiative. https://www.dublincore.org/specifications/dublin-core/dcmi-terms/terms/subject
DCTableOfContents
Description
This class models an DublinCore 'tableOfContents' element
Format
 R6Class object.
Value
Object of  R6Class for modelling an Dublin Core Terms 'tableOfContents' element
Super classes
atom4R::atom4RLogger -> atom4R::AtomAbstractObject -> atom4R::DCElement -> atom4R::DCDescription -> DCTableOfContents
Methods
Public methods
Inherited methods
- atom4R::atom4RLogger$ERROR()
- atom4R::atom4RLogger$INFO()
- atom4R::atom4RLogger$WARN()
- atom4R::atom4RLogger$logger()
- atom4R::AtomAbstractObject$addListElement()
- atom4R::AtomAbstractObject$contains()
- atom4R::AtomAbstractObject$createElement()
- atom4R::AtomAbstractObject$decode()
- atom4R::AtomAbstractObject$delListElement()
- atom4R::AtomAbstractObject$encode()
- atom4R::AtomAbstractObject$getClass()
- atom4R::AtomAbstractObject$getClassName()
- atom4R::AtomAbstractObject$getNamespace()
- atom4R::AtomAbstractObject$getNamespaceDefinition()
- atom4R::AtomAbstractObject$getRootElement()
- atom4R::AtomAbstractObject$getXmlElement()
- atom4R::AtomAbstractObject$isDocument()
- atom4R::AtomAbstractObject$isFieldInheritedFrom()
- atom4R::AtomAbstractObject$print()
- atom4R::AtomAbstractObject$save()
- atom4R::AtomAbstractObject$setIsDocument()
- atom4R::AtomAbstractObject$validate()
Method new()
Initializes an object of class DCTableOfContents
Usage
DCTableOfContents$new(xml = NULL, value = NULL)
Arguments
- xml
- object of class XMLInternalNode-class from XML 
- value
- value 
Method clone()
The objects of this class are cloneable with this method.
Usage
DCTableOfContents$clone(deep = FALSE)
Arguments
- deep
- Whether to make a deep clone. 
References
Dublin Core Metadata Initiative. https://www.dublincore.org/specifications/dublin-core/dcmi-terms/terms/tableOfContents
DCTemporal
Description
This class models an DublinCore 'temporal' element
Format
 R6Class object.
Value
Object of  R6Class for modelling an Dublin Core Terms 'temporal' element
Super classes
atom4R::atom4RLogger -> atom4R::AtomAbstractObject -> atom4R::DCElement -> atom4R::DCCoverage -> DCTemporal
Methods
Public methods
Inherited methods
- atom4R::atom4RLogger$ERROR()
- atom4R::atom4RLogger$INFO()
- atom4R::atom4RLogger$WARN()
- atom4R::atom4RLogger$logger()
- atom4R::AtomAbstractObject$addListElement()
- atom4R::AtomAbstractObject$contains()
- atom4R::AtomAbstractObject$createElement()
- atom4R::AtomAbstractObject$decode()
- atom4R::AtomAbstractObject$delListElement()
- atom4R::AtomAbstractObject$encode()
- atom4R::AtomAbstractObject$getClass()
- atom4R::AtomAbstractObject$getClassName()
- atom4R::AtomAbstractObject$getNamespace()
- atom4R::AtomAbstractObject$getNamespaceDefinition()
- atom4R::AtomAbstractObject$getRootElement()
- atom4R::AtomAbstractObject$getXmlElement()
- atom4R::AtomAbstractObject$isDocument()
- atom4R::AtomAbstractObject$isFieldInheritedFrom()
- atom4R::AtomAbstractObject$print()
- atom4R::AtomAbstractObject$save()
- atom4R::AtomAbstractObject$setIsDocument()
- atom4R::AtomAbstractObject$validate()
Method new()
Initializes an object of class DCTemporal
Usage
DCTemporal$new(xml = NULL, value = NULL)
Arguments
- xml
- object of class XMLInternalNode-class from XML 
- value
- value 
Method clone()
The objects of this class are cloneable with this method.
Usage
DCTemporal$clone(deep = FALSE)
Arguments
- deep
- Whether to make a deep clone. 
References
Dublin Core Metadata Initiative. https://www.dublincore.org/specifications/dublin-core/dcmi-terms/terms/temporal
DCTitle
Description
This class models an DublinCore 'title' element
Format
 R6Class object.
Value
Object of  R6Class for modelling an Dublin Core Terms 'title' element
Super classes
atom4R::atom4RLogger -> atom4R::AtomAbstractObject -> atom4R::DCElement -> DCTitle
Methods
Public methods
Inherited methods
- atom4R::atom4RLogger$ERROR()
- atom4R::atom4RLogger$INFO()
- atom4R::atom4RLogger$WARN()
- atom4R::atom4RLogger$logger()
- atom4R::AtomAbstractObject$addListElement()
- atom4R::AtomAbstractObject$contains()
- atom4R::AtomAbstractObject$createElement()
- atom4R::AtomAbstractObject$decode()
- atom4R::AtomAbstractObject$delListElement()
- atom4R::AtomAbstractObject$encode()
- atom4R::AtomAbstractObject$getClass()
- atom4R::AtomAbstractObject$getClassName()
- atom4R::AtomAbstractObject$getNamespace()
- atom4R::AtomAbstractObject$getNamespaceDefinition()
- atom4R::AtomAbstractObject$getRootElement()
- atom4R::AtomAbstractObject$getXmlElement()
- atom4R::AtomAbstractObject$isDocument()
- atom4R::AtomAbstractObject$isFieldInheritedFrom()
- atom4R::AtomAbstractObject$print()
- atom4R::AtomAbstractObject$save()
- atom4R::AtomAbstractObject$setIsDocument()
- atom4R::AtomAbstractObject$validate()
Method new()
This method is used to create an Dublin core 'title' element.
Use dc to TRUE to use Dublin core namespace instead of DC terms.
Usage
DCTitle$new(xml = NULL, term = NULL, value = NULL, dc = FALSE)
Arguments
- xml
- object of class XMLInternalNode-class from XML 
- term
- term 
- value
- value 
- dc
- use DC namespace? 
Method clone()
The objects of this class are cloneable with this method.
Usage
DCTitle$clone(deep = FALSE)
Arguments
- deep
- Whether to make a deep clone. 
References
Dublin Core Metadata Initiative. https://www.dublincore.org/specifications/dublin-core/dcmi-terms/terms/title
DCType
Description
This class models an DublinCore 'type' element
Format
 R6Class object.
Value
Object of  R6Class for modelling an Dublin Core Terms 'type' element
Super classes
atom4R::atom4RLogger -> atom4R::AtomAbstractObject -> atom4R::DCElement -> DCType
Methods
Public methods
Inherited methods
- atom4R::atom4RLogger$ERROR()
- atom4R::atom4RLogger$INFO()
- atom4R::atom4RLogger$WARN()
- atom4R::atom4RLogger$logger()
- atom4R::AtomAbstractObject$addListElement()
- atom4R::AtomAbstractObject$contains()
- atom4R::AtomAbstractObject$createElement()
- atom4R::AtomAbstractObject$decode()
- atom4R::AtomAbstractObject$delListElement()
- atom4R::AtomAbstractObject$encode()
- atom4R::AtomAbstractObject$getClass()
- atom4R::AtomAbstractObject$getClassName()
- atom4R::AtomAbstractObject$getNamespace()
- atom4R::AtomAbstractObject$getNamespaceDefinition()
- atom4R::AtomAbstractObject$getRootElement()
- atom4R::AtomAbstractObject$getXmlElement()
- atom4R::AtomAbstractObject$isDocument()
- atom4R::AtomAbstractObject$isFieldInheritedFrom()
- atom4R::AtomAbstractObject$print()
- atom4R::AtomAbstractObject$save()
- atom4R::AtomAbstractObject$setIsDocument()
- atom4R::AtomAbstractObject$validate()
Method new()
This method is used to create an Dublin core 'type' element.
Use dc to TRUE to use Dublin core namespace instead of DC terms.
Usage
DCType$new(xml = NULL, value = NULL, dc = FALSE)
Arguments
- xml
- object of class XMLInternalNode-class from XML 
- value
- value 
- dc
- use DC namespace? 
Method clone()
The objects of this class are cloneable with this method.
Usage
DCType$clone(deep = FALSE)
Arguments
- deep
- Whether to make a deep clone. 
References
Dublin Core Metadata Initiative. https://www.dublincore.org/specifications/dublin-core/dcmi-terms/terms/type
DCValid
Description
This class models an DublinCore 'valid' element
Format
 R6Class object.
Value
Object of  R6Class for modelling an Dublin Core Terms 'valid' element
Super classes
atom4R::atom4RLogger -> atom4R::AtomAbstractObject -> atom4R::DCElement -> atom4R::DCDate -> DCValid
Methods
Public methods
Inherited methods
- atom4R::atom4RLogger$ERROR()
- atom4R::atom4RLogger$INFO()
- atom4R::atom4RLogger$WARN()
- atom4R::atom4RLogger$logger()
- atom4R::AtomAbstractObject$addListElement()
- atom4R::AtomAbstractObject$contains()
- atom4R::AtomAbstractObject$createElement()
- atom4R::AtomAbstractObject$decode()
- atom4R::AtomAbstractObject$delListElement()
- atom4R::AtomAbstractObject$encode()
- atom4R::AtomAbstractObject$getClass()
- atom4R::AtomAbstractObject$getClassName()
- atom4R::AtomAbstractObject$getNamespace()
- atom4R::AtomAbstractObject$getNamespaceDefinition()
- atom4R::AtomAbstractObject$getRootElement()
- atom4R::AtomAbstractObject$getXmlElement()
- atom4R::AtomAbstractObject$isDocument()
- atom4R::AtomAbstractObject$isFieldInheritedFrom()
- atom4R::AtomAbstractObject$print()
- atom4R::AtomAbstractObject$save()
- atom4R::AtomAbstractObject$setIsDocument()
- atom4R::AtomAbstractObject$validate()
Method new()
Initializes an object of class DCValid
Usage
DCValid$new(xml = NULL, value = NULL)
Arguments
- xml
- object of class XMLInternalNode-class from XML 
- value
- value 
Method clone()
The objects of this class are cloneable with this method.
Usage
DCValid$clone(deep = FALSE)
Arguments
- deep
- Whether to make a deep clone. 
References
Dublin Core Metadata Initiative. https://www.dublincore.org/specifications/dublin-core/dcmi-terms/terms/valid
SwordClient class
Description
This class models an Sword service client
Format
 R6Class object.
Details
SwordClient
Value
Object of  R6Class for modelling an Sword client
Super classes
atom4R::atom4RLogger -> atom4R::AtomPubClient -> SwordClient
Methods
Public methods
Inherited methods
- atom4R::atom4RLogger$ERROR()
- atom4R::atom4RLogger$INFO()
- atom4R::atom4RLogger$WARN()
- atom4R::atom4RLogger$getClass()
- atom4R::atom4RLogger$getClassName()
- atom4R::atom4RLogger$logger()
- atom4R::AtomPubClient$getPwd()
- atom4R::AtomPubClient$getToken()
- atom4R::AtomPubClient$getUser()
- atom4R::AtomPubClient$listCollections()
Method new()
This method is to instantiate an Sword Client. By default the version is set to "2".
The keyring_backend can be set to use a different backend for storing
the SWORD API user token with keyring (Default value is 'env').
The logger allows to specify the level of log (default is NULL), either "INFO"
for atom4R logs or "DEBUG" for verbose HTTP client (curl) logs.
Usage
SwordClient$new( url, version = "2", user = NULL, pwd = NULL, token = NULL, logger = NULL, keyring_backend = "env" )
Arguments
- url
- url 
- version
- version. Default is "2" 
- user
- user 
- pwd
- pwd 
- token
- token 
- logger
- logger 
- keyring_backend
- keyring backend. Default is 'env' 
Method getServiceDocument()
Get service document
Usage
SwordClient$getServiceDocument(force = FALSE)
Arguments
- force
- force Force getting/refreshing of service document 
Returns
object of class SwordServiceDocument
Method getCollectionMembers()
Get collection members. Unimplemented abstract method at SwordClient level
Usage
SwordClient$getCollectionMembers()
Method clone()
The objects of this class are cloneable with this method.
Usage
SwordClient$clone(deep = FALSE)
Arguments
- deep
- Whether to make a deep clone. 
Note
Abstract class
Author(s)
Emmanuel Blondel <emmanuel.blondel1@gmail.com>
SWORD Dataverse client class
Description
This class models an Sword service Dataverse-specific API client
Format
 R6Class object.
Details
SwordDataverseClient
Value
Object of  R6Class for modelling an Sword Dataverse-specific APIclient
Super classes
atom4R::atom4RLogger -> atom4R::AtomPubClient -> atom4R::SwordClient -> SwordDataverseClient
Methods
Public methods
Inherited methods
- atom4R::atom4RLogger$ERROR()
- atom4R::atom4RLogger$INFO()
- atom4R::atom4RLogger$WARN()
- atom4R::atom4RLogger$getClass()
- atom4R::atom4RLogger$getClassName()
- atom4R::atom4RLogger$logger()
- atom4R::AtomPubClient$getPwd()
- atom4R::AtomPubClient$getToken()
- atom4R::AtomPubClient$getUser()
- atom4R::AtomPubClient$listCollections()
Method new()
This method is to instantiate an Sword API Dataverse-specific Client.
The keyring_backend can be set to use a different backend for storing
the SWORD DataVerse API user token with keyring (Default value is 'env').
The logger allows to specify the level of log (default is NULL), either "INFO"
for atom4R logs or "DEBUG" for verbose HTTP client (curl) logs.
Usage
SwordDataverseClient$new( hostname, token = NULL, logger = NULL, keyring_backend = "env" )
Arguments
- hostname
- host name 
- token
- token 
- logger
- logger 
- keyring_backend
- keyring backend. Default is 'env' 
Method getServiceDocument()
Get service document
Usage
SwordDataverseClient$getServiceDocument(force = FALSE)
Arguments
- force
- force Force getting/refreshing of service document 
Returns
object of class SwordServiceDocument
Method getCollectionMembers()
Get collection members
Usage
SwordDataverseClient$getCollectionMembers(collectionId)
Arguments
- collectionId
- collection ID 
Returns
a list of AtomFeed
Method getDataverses()
Get dataverses. Equivalent to listCollections() from AtomPubClient
Usage
SwordDataverseClient$getDataverses(pretty = FALSE)
Arguments
- pretty
- prettify output as - data.frame. Default is- FALSE
Returns
an object of class data.frame
Method getDataverse()
Get dataverse members by dataverse name. Equivlaent to getCollectionMembers()
Usage
SwordDataverseClient$getDataverse(dataverse)
Arguments
- dataverse
- dataverse name 
Returns
a list of AtomFeed
Method editDataverseEntry()
Edits a dataverse entry
Usage
SwordDataverseClient$editDataverseEntry(identifier)
Arguments
- identifier
- identifier 
Returns
an object of class AtomEntry
Method getDataverseRecord()
Get dataverse record
Usage
SwordDataverseClient$getDataverseRecord(identifier)
Arguments
- identifier
- identifier 
Returns
an object of class AtomFeed
Method createDataverseRecord()
Creates a dataverse record
Usage
SwordDataverseClient$createDataverseRecord(dataverse, entry)
Arguments
- dataverse
- dataverse name 
- entry
- entry 
- the
- created AtomEntry 
Method updateDataverseRecord()
Updates a dataverse record
Usage
SwordDataverseClient$updateDataverseRecord(dataverse, entry, identifier)
Arguments
- dataverse
- dataverse name 
- entry
- entry 
- identifier
- identifier of the entry to update 
- the
- created AtomEntry 
Method deleteDataverseRecord()
Deletes a dataverse record
Usage
SwordDataverseClient$deleteDataverseRecord(identifier)
Arguments
- identifier
- identifier 
Returns
TRUE if deleted, or returns an error otherwise
Method publishDataverseRecord()
Publishes a dataverse record
Usage
SwordDataverseClient$publishDataverseRecord(identifier)
Arguments
- identifier
- identifier 
Returns
the published AtomEntry
Method addFilesToDataverseRecord()
Add files to a dataverse record
Usage
SwordDataverseClient$addFilesToDataverseRecord(identifier, files)
Arguments
- identifier
- identifier 
- files
- files 
Method deleteFilesFromDataverseRecord()
Deletes files from a Dataverse record
Usage
SwordDataverseClient$deleteFilesFromDataverseRecord(identifier, files = NULL)
Arguments
- identifier
- identifier 
- files
- files 
Returns
an object of class data.frame giving each file and it's deletion status
Method clone()
The objects of this class are cloneable with this method.
Usage
SwordDataverseClient$clone(deep = FALSE)
Arguments
- deep
- Whether to make a deep clone. 
Author(s)
Emmanuel Blondel <emmanuel.blondel1@gmail.com>
Examples
## Not run: 
   #connect to SWORD Dataverse API
   SWORD <- SwordDataverseClient$new(
     hostname = "localhost:8085",
     token = "<token>",
     logger = "DEBUG"
   )
   #for detailed operations check the wiki at:
   #https://github.com/eblondel/atom4R/wiki#atom4R-publish-sword-dataverse
## End(Not run)
SwordHalClient class
Description
This class models an Sword service client for HAL (Archives Houvertes)
Format
 R6Class object.
Details
SwordHalClient
Value
Object of  R6Class for modelling an Sword client
Super classes
atom4R::atom4RLogger -> atom4R::AtomPubClient -> atom4R::SwordClient -> SwordHalClient
Methods
Public methods
Inherited methods
- atom4R::atom4RLogger$ERROR()
- atom4R::atom4RLogger$INFO()
- atom4R::atom4RLogger$WARN()
- atom4R::atom4RLogger$getClass()
- atom4R::atom4RLogger$getClassName()
- atom4R::atom4RLogger$logger()
- atom4R::AtomPubClient$getPwd()
- atom4R::AtomPubClient$getToken()
- atom4R::AtomPubClient$getUser()
- atom4R::AtomPubClient$listCollections()
Method new()
This method is to instantiate an Sword HAL (Archive Ouvertes - https://hal.science/) Client. By default the version is set to "2".
The keyring_backend can be set to use a different backend for storing
the SWORD API user token with keyring (Default value is 'env').
The logger allows to specify the level of log (default is NULL), either "INFO"
for atom4R logs or "DEBUG" for verbose HTTP client (curl) logs.
Usage
SwordHalClient$new( url, user = NULL, pwd = NULL, logger = NULL, keyring_backend = "env" )
Arguments
- url
- url 
- user
- user 
- pwd
- pwd 
- logger
- logger 
- keyring_backend
- keyring backend. Default value is 'env' 
Method getServiceDocument()
Get service document
Usage
SwordHalClient$getServiceDocument(force = FALSE)
Arguments
- force
- force Force getting/refreshing of service document 
Returns
object of class SwordServiceDocument
Method getCollectionMembers()
Get collection members
Usage
SwordHalClient$getCollectionMembers(collectionId)
Arguments
- collectionId
- collection ID 
Returns
a list of AtomFeed
Method clone()
The objects of this class are cloneable with this method.
Usage
SwordHalClient$clone(deep = FALSE)
Arguments
- deep
- Whether to make a deep clone. 
Note
Experimental
Author(s)
Emmanuel Blondel <emmanuel.blondel1@gmail.com>
SwordServiceDocument class
Description
This class models an Sword service document
Format
 R6Class object.
Details
SwordServiceDocument
Value
Object of  R6Class for modelling an Sword service document
Super class
atom4R::atom4RLogger -> SwordServiceDocument
Public fields
- title
- title 
- collections
- collections 
Methods
Public methods
Inherited methods
Method new()
Initializes a SwordServiceDocument from XML
Usage
SwordServiceDocument$new(xml, logger = NULL)
Arguments
- xml
- object of class XMLInternalNode-class from XML 
- logger
- logger 
Method getTitle()
Get title
Usage
SwordServiceDocument$getTitle()
Returns
object of class character
Method getCollections()
Get collections
Usage
SwordServiceDocument$getCollections()
Returns
object of class character
Method clone()
The objects of this class are cloneable with this method.
Usage
SwordServiceDocument$clone(deep = FALSE)
Arguments
- deep
- Whether to make a deep clone. 
Note
class used internally by atom4R
Author(s)
Emmanuel Blondel <emmanuel.blondel1@gmail.com>
atom4RLogger
Description
atom4RLogger
atom4RLogger
Format
 R6Class object.
Value
Object of  R6Class for modelling a simple logger
Public fields
- verbose.info
- If package info log messages have to be printed out 
- verbose.debug
- If curl debug log messages have to be printed out 
- loggerType
- the type of logger 
Methods
Public methods
Method logger()
Provides log messages
Usage
atom4RLogger$logger(type, text)
Arguments
- type
- type of log ("INFO", "WARN", "ERROR") 
- text
- the log message text 
Method INFO()
Provides INFO log messages
Usage
atom4RLogger$INFO(text)
Arguments
- text
- the log message text 
Method WARN()
Provides WARN log messages
Usage
atom4RLogger$WARN(text)
Arguments
- text
- the log message text 
Method ERROR()
Provides ERROR log messages
Usage
atom4RLogger$ERROR(text)
Arguments
- text
- the log message text 
Method new()
Initalizes the logger
Usage
atom4RLogger$new(logger = NULL)
Arguments
- logger
- logger type "INFO", "DEBUG" or - NULL
Method getClassName()
Get class name
Usage
atom4RLogger$getClassName()
Returns
object of class data.frame
Method getClass()
Get class
Usage
atom4RLogger$getClass()
Returns
object of class R6Class
Method clone()
The objects of this class are cloneable with this method.
Usage
atom4RLogger$clone(deep = FALSE)
Arguments
- deep
- Whether to make a deep clone. 
Note
Logger class used internally by atom4R
getAtomClasses
Description
get the list of Atom classes, ie classes extending AtomAbstractObject super class, including classes eventually defined outside atom4R. In case the latter is on the search path, the list of Atom classes will be cached for optimized used by atom4R encoder/decoder.
Usage
getAtomClasses()
Author(s)
Emmanuel Blondel, emmanuel.blondel1@gmail.com
Examples
  getAtomClasses()
getAtomNamespace
Description
getAtomNamespace gets a namespace given its id
Usage
getAtomNamespace(id)
Arguments
| id | namespace prefix | 
Author(s)
Emmanuel Blondel, emmanuel.blondel1@gmail.com
Examples
  getAtomNamespace("GMD")
getAtomNamespaces
Description
getAtomNamespaces gets the list of namespaces registered
Usage
getAtomNamespaces()
Author(s)
Emmanuel Blondel, emmanuel.blondel1@gmail.com
Examples
  getAtomNamespaces()
getAtomSchemas
Description
getAtomSchemas gets the schemas registered in atom4R
Usage
getAtomSchemas()
Author(s)
Emmanuel Blondel, emmanuel.blondel1@gmail.com
Examples
  getAtomSchemas()
getClassesInheriting
Description
get the list of classes inheriting a given super class provided by its name
Usage
getClassesInheriting(classname, extended, pretty)
Arguments
| classname | the name of the superclass for which inheriting sub-classes have to be listed | 
| extended | whether we want to look at user namespace for third-party sub-classes | 
| pretty | prettify the output as  | 
Examples
  getClassesInheriting("DCElement")
getDCMIVocabularies
Description
getDCMIVocabularies allows to get the list of DCMI Vocabularies
registered in atom4R
Usage
getDCMIVocabularies()
Author(s)
Emmanuel Blondel, emmanuel.blondel1@gmail.com
Examples
  getDCMIVocabularies()
getDCMIVocabulary
Description
getDCMIVocabulary allows to get a registered DCMI Vocabulary by id
registered in atom4R
Usage
getDCMIVocabulary(id)
Arguments
| id | identifier of the vocabulary | 
Author(s)
Emmanuel Blondel, emmanuel.blondel1@gmail.com
Examples
  getDCMIVocabulary(id = "http://purl.org/dc/dcmitype/")
readDCEntry
Description
readDCEntry is a function to read a DC XML entry from a file
or url into an object in the atom4R model.
Usage
readDCEntry(file, url, raw)
Arguments
| file | a valid file path, as object of class  | 
| url | a valid URL, as object of class  | 
| raw | indicates if the function should return the raw XML. By
default this is set to  | 
Value
a atom4R object inheriting DCEntry
Author(s)
Emmanuel Blondel, emmanuel.blondel1@gmail.com
Examples
  dcfile <- paste0(
    "https://raw.githubusercontent.com/eblondel/atom4R/master/",
    "inst/extdata/examples/zenodo_dc_export.xml"
  )
  dc <- readDCEntry(dcfile)
registerAtomNamespace
Description
registerAtomNamespace allows to register a new namespace
in atom4R
Usage
registerAtomNamespace(id, uri, force)
Arguments
| id | prefix of the namespace | 
| uri | URI of the namespace | 
| force | logical parameter indicating if registration has be to be forced in case the identified namespace is already registered | 
Author(s)
Emmanuel Blondel, emmanuel.blondel1@gmail.com
Examples
  registerAtomNamespace(id = "myprefix", uri = "http://someuri")
registerAtomSchema
Description
registerAtomSchema allows to register a new schema
in atom4R
Usage
registerAtomSchema(xsdFile)
Arguments
| xsdFile | the schema XSD file | 
Author(s)
Emmanuel Blondel, emmanuel.blondel1@gmail.com
Examples
  atom_xsd_file <- system.file("extdata/schemas/atom/atom.xsd", package = "atom4R")
  registerAtomSchema(xsdFile = atom_xsd_file)
setMetadataNamespaces
Description
setMetadataNamespaces
Usage
setAtomNamespaces()
setAtomSchemas
Description
setAtomSchemas
Usage
setAtomSchemas()
setDCMIVocabularies
Description
setDCMIVocabularies
Usage
setDCMIVocabularies()