gr.uoa.di.madgik.grs.record.field
Class ObjectFieldDefinition

java.lang.Object
  extended by gr.uoa.di.madgik.grs.record.field.FieldDefinition
      extended by gr.uoa.di.madgik.grs.record.field.ObjectFieldDefinition

public class ObjectFieldDefinition
extends FieldDefinition

The FieldDefinition implementation for ObjectField. The compression instruction is not used for the respective ObjectField as the actual payload serialization is performed outside the Field methods

Author:
gpapanikos

Field Summary
static IBuffer.TransportDirective DefaultDirective
          The default transport directive currently set to IBuffer.TransportDirective.Full
static java.lang.String DefaultMimeType
          The default MIME type currently set to text/plain
 
Fields inherited from class gr.uoa.di.madgik.grs.record.field.FieldDefinition
DefaultChunkSize, DefaultDoCompress
 
Constructor Summary
ObjectFieldDefinition()
          Creates a new instance
ObjectFieldDefinition(java.lang.String name)
          Creates a new instance
 
Method Summary
 void extendDeflate(java.io.DataOutput out)
          Method to be implemented by class extenders to deflate additional information
 boolean extendEquals(java.lang.Object obj)
          Method to be implemented by extenders to check if two instances are equal
 void extendFromXML(org.w3c.dom.Element element)
           
 void extendInflate(java.io.DataInput in)
          Method to be implemented by the class extenders to inflate additional information previously deflated
 void extendToXML(org.w3c.dom.Document doc, org.w3c.dom.Element element)
           
 IBuffer.TransportDirective getTransportDirective()
          Retrieves the transport directive to be used during transfer
 void setTransportDirective(IBuffer.TransportDirective directive)
          Sets the transport directive to be used during transfer
 
Methods inherited from class gr.uoa.di.madgik.grs.record.field.FieldDefinition
deflate, equals, fromXML, getChunkSize, getMimeType, getName, inflate, isCompress, setChunkSize, setCompress, setMimeType, setName, toXML
 
Methods inherited from class java.lang.Object
getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

DefaultMimeType

public static final java.lang.String DefaultMimeType
The default MIME type currently set to text/plain

See Also:
Constant Field Values

DefaultDirective

public static final IBuffer.TransportDirective DefaultDirective
The default transport directive currently set to IBuffer.TransportDirective.Full

Constructor Detail

ObjectFieldDefinition

public ObjectFieldDefinition()
Creates a new instance


ObjectFieldDefinition

public ObjectFieldDefinition(java.lang.String name)
Creates a new instance

Parameters:
name - the field definition name
Method Detail

setTransportDirective

public void setTransportDirective(IBuffer.TransportDirective directive)
Sets the transport directive to be used during transfer

The set IBuffer.TransportDirective is not affected. Only the default IBuffer.TransportDirective.Full is supported

Overrides:
setTransportDirective in class FieldDefinition
Parameters:
directive - the directive to be used
See Also:
FieldDefinition.setTransportDirective(gr.uoa.di.madgik.grs.buffer.IBuffer.TransportDirective)

getTransportDirective

public IBuffer.TransportDirective getTransportDirective()
Retrieves the transport directive to be used during transfer

The default IBuffer.TransportDirective.Full is returned

Overrides:
getTransportDirective in class FieldDefinition
Returns:
the transport directive to be used during transfer
See Also:
FieldDefinition.getTransportDirective()

extendEquals

public boolean extendEquals(java.lang.Object obj)
Method to be implemented by extenders to check if two instances are equal

Specified by:
extendEquals in class FieldDefinition
Parameters:
obj - the instance to check for equality
Returns:
true if equal, false otherwise
See Also:
FieldDefinition.extendEquals(java.lang.Object)

extendDeflate

public void extendDeflate(java.io.DataOutput out)
                   throws GRS2RecordSerializationException
Method to be implemented by class extenders to deflate additional information

Specified by:
extendDeflate in class FieldDefinition
Parameters:
out - the stream to deflate to
Throws:
GRS2RecordSerializationException - A serialization error occurred
See Also:
FieldDefinition.extendDeflate(java.io.DataOutput)

extendInflate

public void extendInflate(java.io.DataInput in)
                   throws GRS2RecordSerializationException
Method to be implemented by the class extenders to inflate additional information previously deflated

Specified by:
extendInflate in class FieldDefinition
Parameters:
in - the stream to inflate from
Throws:
GRS2RecordSerializationException - A deserialization error occurred
See Also:
FieldDefinition.extendInflate(java.io.DataInput)

extendToXML

public void extendToXML(org.w3c.dom.Document doc,
                        org.w3c.dom.Element element)
                 throws GRS2RecordSerializationException
Specified by:
extendToXML in class FieldDefinition
Throws:
GRS2RecordSerializationException

extendFromXML

public void extendFromXML(org.w3c.dom.Element element)
                   throws GRS2RecordSerializationException
Specified by:
extendFromXML in class FieldDefinition
Throws:
GRS2RecordSerializationException