€cdocutils.nodes
document
q)q}q(U	nametypesq}q(X   investigator toolkitqNX   itk architectureqNuUsubstitution_defsq}q	Uparse_messagesq
]qUcurrent_sourceqNU
decorationqNUautofootnote_startqKUnameidsq}q(hUinvestigator-toolkitqhUitk-architecturequUchildrenq]qcdocutils.nodes
section
q)q}q(U	rawsourceqU UparentqhUsourceqXh   /var/lib/jenkins/jobs/API_Documentation_trunk/workspace/api-documentation/source/design/itk-overview.txtqUtagnameqUsectionqU
attributesq}q(Udupnamesq ]Uclassesq!]Ubackrefsq"]Uidsq#]q$haUnamesq%]q&hauUlineq'KUdocumentq(hh]q)(cdocutils.nodes
title
q*)q+}q,(hX   Investigator Toolkitq-hhhhhUtitleq.h}q/(h ]h!]h"]h#]h%]uh'Kh(hh]q0cdocutils.nodes
Text
q1X   Investigator Toolkitq2…q3}q4(hh-hh+ubaubcdocutils.nodes
paragraph
q5)q6}q7(hX  The Investigator Toolkit provides a suite of software tools that are useful
for the various audiences that DataONE serves. The tools fall in a number
of categories, which are further developed here, with examples of potential
applications that would fit into each category.q8hhhhhU	paragraphq9h}q:(h ]h!]h"]h#]h%]uh'Kh(hh]q;h1X  The Investigator Toolkit provides a suite of software tools that are useful
for the various audiences that DataONE serves. The tools fall in a number
of categories, which are further developed here, with examples of potential
applications that would fit into each category.q<…q=}q>(hh8hh6ubaubcdocutils.nodes
compound
q?)q@}qA(hU hhhhhUcompoundqBh}qC(h ]h!]qDUtoctree-wrapperqEah"]h#]h%]uh'Nh(hh]qFcsphinx.addnodes
toctree
qG)qH}qI(hU hh@hhhUtoctreeqJh}qK(UnumberedqLK UincludehiddenqM‰hX   design/itk-overviewqNUcaptionqONUglobqP‰h#]h"]U
titlesonlyqQ‰h ]h!]h%]UentriesqR]qS(NX   design/itk-webqT†qUNX   design/itk-metadataqV†qWNX   design/itk-analysisqX†qYNX   design/itk-librariesqZ†q[eUhiddenq\‰Uincludefilesq]]q^(hThVhXhZeUmaxdepthq_Kuh'K	h]ubaubh)q`}qa(hU hhhhhhh}qb(h ]h!]h"]h#]qchah%]qdhauh'Kh(hh]qe(h*)qf}qg(hX   ITK Architectureqhhh`hhhh.h}qi(h ]h!]h"]h#]h%]uh'Kh(hh]qjh1X   ITK Architectureqk…ql}qm(hhhhhfubaubh5)qn}qo(hX  Outline of class structure for the client library. There are two fundamental
elements: nodes and granules. The former representing the base of Member and
Coordinating Node functionality, and the later representing the (currently)
smallest addressable unit of content in DataONE.qphh`hhhh9h}qq(h ]h!]h"]h#]h%]uh'Kh(hh]qrh1X  Outline of class structure for the client library. There are two fundamental
elements: nodes and granules. The former representing the base of Member and
Coordinating Node functionality, and the later representing the (currently)
smallest addressable unit of content in DataONE.qs…qt}qu(hhphhnubaubcdocutils.nodes
comment
qv)qw}qx(hXÁ  @startuml images/itk_structure.png

  NodeClient --|> CNodeClient
  NodeClient --|> MNodeClient

  DataOneClient .. CNodeClient
  DataOneClient .. MNodeClient

  DataOneClient --|> CachingDataOneClient

  Granule .. SystemMetadata

  Granule --|> DataObject
  Granule --|> ScienceMetadata
  Granule --|> DataPackage

  class CNodeClient {
    Node[] : resolve(Identifier pid)
  }

  class DataOneClient {
    CNodeClient : getCNodeClient()
    MNodeClient : getMNodeClient()

    Identifier[] : search(String query, long start, long count)
    Granule : get(Identifier)
  }

  class Granule {
    - DataOneClient : client
    - DataOneClient : getClient()
    Identifier : getPid()
    ObjectFormatIdentifier : getFormatId()
    long : getSize()
    ByteStream : get(Node node)
    Granule[] : getPackages()
  }

  class DataObject {
    Granule[] : getDocumentedBy()
  }

  class ScienceMetadata {
    Granule[] : getDocuments()
  }

  class DataPackage {
    Granule[] : getGranules()
    ScienceMetadata[] : getDocuments()
    DataObject[] : getData()
  }


  class SystemMetadata {
    + serialVersion : xs.long[1..1]
    + identifier : Identifier[1..1]
    + formatid : ObjectFormatIdentifier[1..1]
    + size : xs.unsignedLong[1..1]
    + checksum : Checksum[1..1]
    + submitter : Subject[1..1]
    + rightsHolder : Subject[1..1]
    + accessPolicy : AccessPolicy[0..1]
    + replicationPolicy : ReplicationPolicy[0..1]
    + obsoletes : Identifier[0..1]
    + obsoletedBy : Identifier[0..1]
    + dateUploaded : xs.dateTime[1..1]
    + dateSysMetadataModified : xs.dateTime[1..1]
    + originMemberNode : NodeReference[0..1]
    + authoritativeMemberNode : NodeReference[0..1]
    + replica : Replica[0..*]
  }


@endumlhh`hhhUcommentqyh}qz(U	xml:spaceq{Upreserveq|h#]h"]h ]h!]h%]uh'Keh(hh]q}h1XÁ  @startuml images/itk_structure.png

  NodeClient --|> CNodeClient
  NodeClient --|> MNodeClient

  DataOneClient .. CNodeClient
  DataOneClient .. MNodeClient

  DataOneClient --|> CachingDataOneClient

  Granule .. SystemMetadata

  Granule --|> DataObject
  Granule --|> ScienceMetadata
  Granule --|> DataPackage

  class CNodeClient {
    Node[] : resolve(Identifier pid)
  }

  class DataOneClient {
    CNodeClient : getCNodeClient()
    MNodeClient : getMNodeClient()

    Identifier[] : search(String query, long start, long count)
    Granule : get(Identifier)
  }

  class Granule {
    - DataOneClient : client
    - DataOneClient : getClient()
    Identifier : getPid()
    ObjectFormatIdentifier : getFormatId()
    long : getSize()
    ByteStream : get(Node node)
    Granule[] : getPackages()
  }

  class DataObject {
    Granule[] : getDocumentedBy()
  }

  class ScienceMetadata {
    Granule[] : getDocuments()
  }

  class DataPackage {
    Granule[] : getGranules()
    ScienceMetadata[] : getDocuments()
    DataObject[] : getData()
  }


  class SystemMetadata {
    + serialVersion : xs.long[1..1]
    + identifier : Identifier[1..1]
    + formatid : ObjectFormatIdentifier[1..1]
    + size : xs.unsignedLong[1..1]
    + checksum : Checksum[1..1]
    + submitter : Subject[1..1]
    + rightsHolder : Subject[1..1]
    + accessPolicy : AccessPolicy[0..1]
    + replicationPolicy : ReplicationPolicy[0..1]
    + obsoletes : Identifier[0..1]
    + obsoletedBy : Identifier[0..1]
    + dateUploaded : xs.dateTime[1..1]
    + dateSysMetadataModified : xs.dateTime[1..1]
    + originMemberNode : NodeReference[0..1]
    + authoritativeMemberNode : NodeReference[0..1]
    + replica : Replica[0..*]
  }


@endumlq~…q}q€(hU hhwubaubeubeubahU UtransformerqNUfootnote_refsq‚}qƒUrefnamesq„}q…Usymbol_footnotesq†]q‡Uautofootnote_refsqˆ]q‰Usymbol_footnote_refsqŠ]q‹U	citationsqŒ]qh(hUcurrent_lineqŽNUtransform_messagesq]qUreporterq‘NUid_startq’KUautofootnotesq“]q”Ucitation_refsq•}q–Uindirect_targetsq—]q˜Usettingsq™(cdocutils.frontend
Values
qšoq›}qœ(Ufootnote_backlinksqKUrecord_dependenciesqžNUrfc_base_urlqŸUhttps://tools.ietf.org/html/q U	tracebackq¡ˆUpep_referencesq¢NUstrip_commentsq£NUtoc_backlinksq¤Uentryq¥Ulanguage_codeq¦Uenq§U	datestampq¨NUreport_levelq©KU_destinationqªNU
halt_levelq«KUstrip_classesq¬Nh.NUerror_encoding_error_handlerq­Ubackslashreplaceq®Udebugq¯NUembed_stylesheetq°‰Uoutput_encoding_error_handlerq±Ustrictq²Usectnum_xformq³KUdump_transformsq´NUdocinfo_xformqµKUwarning_streamq¶NUpep_file_url_templateq·Upep-%04dq¸Uexit_status_levelq¹KUconfigqºNUstrict_visitorq»NUcloak_email_addressesq¼ˆUtrim_footnote_reference_spaceq½‰Uenvq¾NUdump_pseudo_xmlq¿NUexpose_internalsqÀNUsectsubtitle_xformqÁ‰Usource_linkqÂNUrfc_referencesqÃNUoutput_encodingqÄUutf-8qÅU
source_urlqÆNUinput_encodingqÇU	utf-8-sigqÈU_disable_configqÉNU	id_prefixqÊU U	tab_widthqËKUerror_encodingqÌUUTF-8qÍU_sourceqÎhUgettext_compactqÏˆU	generatorqÐNUdump_internalsqÑNUsmart_quotesqÒ‰Upep_base_urlqÓU https://www.python.org/dev/peps/qÔUsyntax_highlightqÕUlongqÖUinput_encoding_error_handlerq×h²Uauto_id_prefixqØUidqÙUdoctitle_xformqÚ‰Ustrip_elements_with_classesqÛNU_config_filesqÜ]Ufile_insertion_enabledqÝˆUraw_enabledqÞKUdump_settingsqßNubUsymbol_footnote_startqàK Uidsqá}qâ(hhhh`uUsubstitution_namesqã}qähh(h}qå(h ]h#]h"]Usourcehh!]h%]uU	footnotesqæ]qçUrefidsqè}qéub.