Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep

net.jxta.codat
Class Codat  view Codat download Codat.java

java.lang.Object
  extended bynet.jxta.codat.Codat
Direct Known Subclasses:
Metadata

public class Codat
extends java.lang.Object

Codats are container objects that can hold both data or code and are associated with a JXTA ID. The Codat class is offered as a standard way for applications and services to exchange any kind of contents via a common API and associate a unique JXTA id to these contents.

Codats are containers objects that are used to hold any kinds of objects or data. A codat can represent a file, a class file, the saved state of an application, a loadable C library. Codats are handled transparently by the JXTA platform, and are used as placeholders for any types of data. Codats hold Document that represent the data that they hold.

Codats are published in peer groups. A Codat can belong to only one peer group. Multiple copies of a codat can be made to be published in multiple peer groups.

Codats are uniquely identified via a unique CodatID. This Id is guaranteed to be unique within the JXTA world.

The core manipulates two main types of codats:

The JXTA platform defines Codat as the unit of information shared and exchanged within a JXTA group. All instances of Codats reside within a peer group. The PeerGroup content caching service provides storage and retrieval methods for codats using codatId as index.


Field Summary
protected  net.jxta.document.Document doc
          A JXTA Document which contains the data held by this Codat.
protected  net.jxta.id.ID id
          Id of this Codat.
protected  net.jxta.id.ID metaId
          Codat Id of a Codat to which this Codat is related.
 
Constructor Summary
Codat(CodatID id, CodatID about, net.jxta.document.Document document)
          Makes a new Codat instance from an existing Codat, with a given CodatID and a document.
Codat(net.jxta.peergroup.PeerGroupID groupID, net.jxta.id.ID about, net.jxta.document.Document document)
          Makes a new Codat with a new CodatId given a PeerGroupID and a document.
 
Method Summary
 net.jxta.id.ID getCodatID()
          Returns the CodatId associated with this Codat.
 net.jxta.document.Document getDocument()
          Returns the Document associated with this Codat.
 net.jxta.id.ID getMetaID()
          Returns Codat id of related codat associated with this metadata Codat.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

id

protected net.jxta.id.ID id
Id of this Codat. This is the "address" which may be used to refer to this Codat. see CodatID


metaId

protected net.jxta.id.ID metaId
Codat Id of a Codat to which this Codat is related. This may be the Codat Id of another codat in the same Peer Group or nullID


doc

protected net.jxta.document.Document doc
A JXTA Document which contains the data held by this Codat.

Constructor Detail

Codat

public Codat(net.jxta.peergroup.PeerGroupID groupID,
             net.jxta.id.ID about,
             net.jxta.document.Document document)
      throws java.io.IOException
Makes a new Codat with a new CodatId given a PeerGroupID and a document.


Codat

public Codat(CodatID id,
             CodatID about,
             net.jxta.document.Document document)
Makes a new Codat instance from an existing Codat, with a given CodatID and a document.

Method Detail

getCodatID

public net.jxta.id.ID getCodatID()
Returns the CodatId associated with this Codat.


getMetaID

public net.jxta.id.ID getMetaID()
Returns Codat id of related codat associated with this metadata Codat.


getDocument

public net.jxta.document.Document getDocument()
Returns the Document associated with this Codat.