org.ipdr.common
Class IPDRHeader

java.lang.Object
  extended by org.ipdr.common.IPDRHeader

public class IPDRHeader
extends java.lang.Object

This class contains the variables and methods to store the header information.


Field Summary
static short COMPACT_FORMAT_3_0_OR_3_1
          the compact format version number for IPDR v3.0 and v3.1
static short COMPACT_FORMAT_3_5
          the compact format version number for IPDR v3.5
 java.lang.String defaultNameSpaceURI_
          Identifies the default nameSpace
 byte[] docId_
          The UUID associated with this document
 java.lang.String ipdrRecorderInfo_
          Identification information for the producer of this document
 NameSpaceInfo[] otherNameSpaces_
          Identifies the additional nameSpaces from which the attributes are derived
 java.lang.String[] schemaNameSpaces_
          Identifies the schema nameSpaces
 java.lang.String[] serviceDefinitionURIs_
          Identifies the set of service definitions from which the records are produced
 long startTime_
          Start time of the IPDRDoc
 
Constructor Summary
IPDRHeader()
          Constructor method
IPDRHeader(java.lang.String ipdrRecorderInfo, long startTime, java.lang.String defaultNameSpaceURI, NameSpaceInfo[] otherNameSpaces, java.lang.String[] schemaNameSpaces, java.lang.String[] serviceDefinitionURIs, byte[] docId)
          Builds a composite type from the supplied array of objects and the type specifier.
 
Method Summary
 java.lang.String getDefaultNameSpaceURI()
          Returns the name space URI associated with the unqualified attribute names in this document.
 byte[] getDocId()
          Get the unique document id.
 java.lang.String getIPDRRecorderInfo()
          Returns the RecorderInfo string which describes the entity which initially created this document.
 NameSpaceInfo[] getOtherNameSpaces()
          Returns the name space URIs associated with the qualified attribute names in this document.
 java.lang.String[] getSchemaNameSpaces()
          Returns the schema namespace URIs
 java.lang.String[] getServiceDefinitionURIs()
          Get the URIs which describe the IPDR service definitions used in constructing these events.
 long getStartTime()
          Returns the timestamp recorded in this document representing when the document was initially opened for writing.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

ipdrRecorderInfo_

public java.lang.String ipdrRecorderInfo_
Identification information for the producer of this document


startTime_

public long startTime_
Start time of the IPDRDoc


defaultNameSpaceURI_

public java.lang.String defaultNameSpaceURI_
Identifies the default nameSpace


otherNameSpaces_

public NameSpaceInfo[] otherNameSpaces_
Identifies the additional nameSpaces from which the attributes are derived


schemaNameSpaces_

public java.lang.String[] schemaNameSpaces_
Identifies the schema nameSpaces


serviceDefinitionURIs_

public java.lang.String[] serviceDefinitionURIs_
Identifies the set of service definitions from which the records are produced


docId_

public byte[] docId_
The UUID associated with this document


COMPACT_FORMAT_3_0_OR_3_1

public static final short COMPACT_FORMAT_3_0_OR_3_1
the compact format version number for IPDR v3.0 and v3.1

See Also:
Constant Field Values

COMPACT_FORMAT_3_5

public static final short COMPACT_FORMAT_3_5
the compact format version number for IPDR v3.5

See Also:
Constant Field Values
Constructor Detail

IPDRHeader

public IPDRHeader()
Constructor method


IPDRHeader

public IPDRHeader(java.lang.String ipdrRecorderInfo,
                  long startTime,
                  java.lang.String defaultNameSpaceURI,
                  NameSpaceInfo[] otherNameSpaces,
                  java.lang.String[] schemaNameSpaces,
                  java.lang.String[] serviceDefinitionURIs,
                  byte[] docId)
Builds a composite type from the supplied array of objects and the type specifier. The two must be in agreement.

Parameters:
ipdrRecorderInfo - Identification information for the producer of this document. Typcially URI, or blank.
startTime - The number of milliseconds since the Epoch (00:00:00 UTC, January 1, 1970).
defaultNameSpaceURI - Identifies the default Namespace associated with this record. Those attribute names which are unqualified will be assumed to be from this namespace.
otherNameSpaces - Identifies additional namespaces from which attributes are derived. This list may be empty.
schemaNameSpaces - Identifies schema namespaces from which attributes are derived. This list may be empty.
serviceDefinitionURIs - Identifies the set of service definitions from which the records are produced.
docId - The UUID associated with this document.
Method Detail

getIPDRRecorderInfo

public java.lang.String getIPDRRecorderInfo()
Returns the RecorderInfo string which describes the entity which initially created this document.

Returns:
The iPDRRecorderInfo value

getStartTime

public long getStartTime()
Returns the timestamp recorded in this document representing when the document was initially opened for writing. Time is represented as a 64-bit quantity representing the number of milliseconds since 00:00 Jan 1, 1970 GMT.

Returns:
The startTime value

getDefaultNameSpaceURI

public java.lang.String getDefaultNameSpaceURI()
Returns the name space URI associated with the unqualified attribute names in this document.

Returns:
The defaultNameSpaceURI value

getOtherNameSpaces

public NameSpaceInfo[] getOtherNameSpaces()
Returns the name space URIs associated with the qualified attribute names in this document. A qualified attribute is expressed in the form : (e.g. ns1:myattr). The Namespace info associates the shorthand name with the full namespace URI.

Returns:
The otherNameSpaces value

getSchemaNameSpaces

public java.lang.String[] getSchemaNameSpaces()
Returns the schema namespace URIs

Returns:
The schemaNameSpaces value

getServiceDefinitionURIs

public java.lang.String[] getServiceDefinitionURIs()
Get the URIs which describe the IPDR service definitions used in constructing these events.

Returns:
The serviceDefinitionURIs value

getDocId

public byte[] getDocId()
Get the unique document id. This is a UUID, which consists of 16 bytes. The format of UUID's is defined

Returns:
The docId value