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

java.lang.Object
  gr.uoa.di.madgik.grs.record.field.Field
      gr.uoa.di.madgik.grs.record.field.FileField

All Implemented Interfaces:

IPumpable, Serializable

public class FileField
extends Field

Field holding the payload of a File that is only available in the writer's host. In cases of remote access, the field is used to fully or partially and gradually move its payload to the remote host

Author:

gpapanikos

See Also:

Serialized Form

Field Summary

Fields inherited from class gr.uoa.di.madgik.grs.record.field.Field

record

Constructor Summary

FileField()
Creates a new instance

FileField(File payload)
Creates a new instance

Method Summary

void	extendDeflate(DataOutput out) Method that needs to be implemented by the class extenders to deflate the information they keep
void	extendDispose() Method to be implemented by class extenders to dispose their internal state
void	extendFromXML(Element element, boolean reset)
void	extendInflate(DataInput in, boolean reset) Method that needs to be implemented by the Field extenders to inflate their internal information
protected void	extendMakeLocal() Method that needs to be implemented by the class extenders to reset any additional information concerning previous executed transfers they keep and make the field behave as if it were local
void	extendReadObject(ObjectInputStream in, IBuffer.TransportOverride override)
void	extendReceive(DataInput in, IBuffer.TransportOverride override) Method that needs to be implemented by the Field extenders to receive their priveously send information
void	extendReceiveFromXML(Element element, IBuffer.TransportOverride override)
void	extendSend(DataOutput out, IBuffer.TransportOverride override) Method that needs to be implemented by the class extenders to send the information they keep
void	extendSendToXML(Document doc, Element element, IBuffer.TransportOverride override)
void	extendToXML(Document doc, Element element)
void	extendWriteObject(ObjectOutputStream out, IBuffer.TransportOverride override)
FileFieldDefinition	getFieldDefinition() Retrieves the FieldDefinition based on the definition index and the bound Record RecordDefinition
InputStream	getInputStream() Provides an InputStream over the locally available payload of the Field
File	getOriginalPayload() Retrieves the original field payload.
File	getPayload() Retrieves the payload of the field
boolean	isAvailable() Method that needs to be implemented by class extenders to indicate in case of a remote field copy when the field is not expecting any more data from its original instance.
void	setPayload(File payload) Sets the payload of the field

Methods inherited from class gr.uoa.di.madgik.grs.record.field.Field

bind, deflate, dispose, fromXML, fromXML, getDefinitionIndex, getMediatingInputStream, inflate, inflate, isRemoteCopy, makeAvailable, makeAvailable, makeLocal, prebind, receive, receiveFromXML, resolveTransportDirective, send, sendToXML, setDefinitionIndex, setRemoteCopy, toXML

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FileField

public FileField()

Creates a new instance

FileField

public FileField(File payload)

Creates a new instance

Parameters:

payload - the payload of the field

Method Detail

setPayload

public void setPayload(File payload)

Sets the payload of the field

Parameters:

payload -

getPayload

public File getPayload()

Retrieves the payload of the field

Returns:

the field payload

Throws:

GRS2RecordException

getOriginalPayload

public File getOriginalPayload()

Retrieves the original field payload. In the writer's side, this value will point to the same location as the getPayload(). In the reader side, this value will not necessarily point to a valid location

Returns:

the original field payload

getFieldDefinition

public FileFieldDefinition getFieldDefinition()
                                       throws GRS2RecordDefinitionException

Retrieves the FieldDefinition based on the definition index and the bound Record RecordDefinition

Overrides:

getFieldDefinition in class Field

Returns:

the field definition

Throws:

GRS2RecordDefinitionException - if the Field is not bound to a Record or no usable definition has been found

See Also:

Field.getFieldDefinition()

isAvailable

public boolean isAvailable()

Method that needs to be implemented by class extenders to indicate in case of a remote field copy when the field is not expecting any more data from its original instance. For an instance that is not remote, the field is always available

Specified by:

isAvailable in class Field

Returns:

whether or not the remote copy is available

See Also:

Field.isAvailable()

getInputStream

public InputStream getInputStream()
                           throws IOException

Provides an InputStream over the locally available payload of the Field

Specified by:

getInputStream in class Field

Returns:

the input stream

Throws:

IOException - The input stream could not be created

See Also:

Field.getInputStream()

extendReadObject

public void extendReadObject(ObjectInputStream in,
                             IBuffer.TransportOverride override)
                      throws IOException,
                             ClassNotFoundException

Throws:

IOException

ClassNotFoundException

extendWriteObject

public void extendWriteObject(ObjectOutputStream out,
                              IBuffer.TransportOverride override)
                       throws IOException

Throws:

IOException

extendSend

public void extendSend(DataOutput out,
                       IBuffer.TransportOverride override)
                throws GRS2RecordSerializationException

Method that needs to be implemented by the class extenders to send the information they keep

Specified by:

extendSend in class Field

Parameters:

out - the stream to send information to

override - the IBuffer.TransportOverride directive

Throws:

GRS2RecordSerializationException - There was a problem in the serialization

See Also:

Field.extendSend(java.io.DataOutput, gr.uoa.di.madgik.grs.buffer.IBuffer.TransportOverride)

extendReceive

public void extendReceive(DataInput in,
                          IBuffer.TransportOverride override)
                   throws GRS2RecordSerializationException

Method that needs to be implemented by the Field extenders to receive their priveously send information

Specified by:

extendReceive in class Field

Parameters:

in - the stream to receive from

override - the IBuffer.TransportOverride to use

Throws:

GRS2RecordSerializationException - There was a problem in the deserialization

See Also:

Field.extendReceive(java.io.DataInput, gr.uoa.di.madgik.grs.buffer.IBuffer.TransportOverride)

extendDispose

public void extendDispose()

Method to be implemented by class extenders to dispose their internal state

Specified by:

extendDispose in class Field

See Also:

Field.extendDispose()

extendDeflate

public void extendDeflate(DataOutput out)
                   throws GRS2RecordSerializationException

Method that needs to be implemented by the class extenders to deflate the information they keep

Specified by:

extendDeflate in class Field

Parameters:

out - the stream to deflate to

Throws:

GRS2RecordSerializationException - There was a problem in the serialization

See Also:

Field.extendDeflate(java.io.DataOutput)

extendToXML

public void extendToXML(Document doc,
                        Element element)
                 throws GRS2RecordSerializationException

Specified by:

extendToXML in class Field

Throws:

GRS2RecordSerializationException

extendFromXML

public void extendFromXML(Element element,
                          boolean reset)
                   throws GRS2RecordSerializationException

Specified by:

extendFromXML in class Field

Throws:

GRS2RecordSerializationException

extendInflate

public void extendInflate(DataInput in,
                          boolean reset)
                   throws GRS2RecordSerializationException

Method that needs to be implemented by the Field extenders to inflate their internal information

Specified by:

extendInflate in class Field

Parameters:

in - the stream to inflate from

reset - whether or not the inflated information needs to be reset to clear any indication of previous executed transfers

Throws:

GRS2RecordSerializationException - There was a problem in the deserialization

See Also:

Field.extendInflate(java.io.DataInput, boolean)

extendMakeLocal

protected void extendMakeLocal()

Method that needs to be implemented by the class extenders to reset any additional information concerning previous executed transfers they keep and make the field behave as if it were local

Specified by:

extendMakeLocal in class Field

See Also:

Field.extendMakeLocal()

extendReceiveFromXML

public void extendReceiveFromXML(Element element,
                                 IBuffer.TransportOverride override)
                          throws GRS2RecordSerializationException

Specified by:

extendReceiveFromXML in class Field

Throws:

GRS2RecordSerializationException

extendSendToXML

public void extendSendToXML(Document doc,
                            Element element,
                            IBuffer.TransportOverride override)
                     throws GRS2RecordSerializationException

Specified by:

extendSendToXML in class Field

Throws:

GRS2RecordSerializationException