|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectgr.uoa.di.madgik.grs.record.field.Field
gr.uoa.di.madgik.grs.record.field.FileField
public class FileField
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
| Constructor Summary | |
|---|---|
FileField()
Creates a new instance |
|
FileField(java.io.File payload)
Creates a new instance |
|
| Method Summary | |
|---|---|
void |
extendDeflate(java.io.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(org.w3c.dom.Element element,
boolean reset)
|
void |
extendInflate(java.io.DataInput in,
boolean reset)
Method that needs to be implemented by the Field extenders to inflate their internal information |
void |
extendReceive(java.io.DataInput in,
IBuffer.TransportOverride override)
Method that needs to be implemented by the Field extenders to receive their priveously send information |
void |
extendReceiveFromXML(org.w3c.dom.Element element,
IBuffer.TransportOverride override)
|
void |
extendSend(java.io.DataOutput out,
IBuffer.TransportOverride override)
Method that needs to be implemented by the class extenders to send the information they keep |
void |
extendSendToXML(org.w3c.dom.Document doc,
org.w3c.dom.Element element,
IBuffer.TransportOverride override)
|
void |
extendToXML(org.w3c.dom.Document doc,
org.w3c.dom.Element element)
|
FileFieldDefinition |
getFieldDefinition()
Retrieves the FieldDefinition based on the definition index and the bound Record RecordDefinition |
java.io.InputStream |
getInputStream()
Provides an InputStream over the locally available payload of the Field |
java.io.File |
getOriginalPayload()
Retrieves the original field payload. |
java.io.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(java.io.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 |
|---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public FileField()
public FileField(java.io.File payload)
payload - the payload of the field| Method Detail |
|---|
public void setPayload(java.io.File payload)
payload - public java.io.File getPayload()
GRS2RecordExceptionpublic java.io.File getOriginalPayload()
getPayload(). In the reader side, this value will not necessarily point to a valid location
public FileFieldDefinition getFieldDefinition()
throws GRS2RecordDefinitionException
FieldDefinition based on the definition index and the bound Record RecordDefinition
getFieldDefinition in class FieldGRS2RecordDefinitionException - if the Field is not bound to a Record or no usable definition has been foundField.getFieldDefinition()public boolean isAvailable()
isAvailable in class FieldField.isAvailable()
public java.io.InputStream getInputStream()
throws java.io.IOException
InputStream over the locally available payload of the Field
getInputStream in class Fieldjava.io.IOException - The input stream could not be createdField.getInputStream()
public void extendSend(java.io.DataOutput out,
IBuffer.TransportOverride override)
throws GRS2RecordSerializationException
extendSend in class Fieldout - the stream to send information tooverride - the IBuffer.TransportOverride directive
GRS2RecordSerializationException - There was a problem in the serializationField.extendSend(java.io.DataOutput, gr.uoa.di.madgik.grs.buffer.IBuffer.TransportOverride)
public void extendReceive(java.io.DataInput in,
IBuffer.TransportOverride override)
throws GRS2RecordSerializationException
Field extenders to receive their priveously send information
extendReceive in class Fieldin - the stream to receive fromoverride - the IBuffer.TransportOverride to use
GRS2RecordSerializationException - There was a problem in the deserializationField.extendReceive(java.io.DataInput, gr.uoa.di.madgik.grs.buffer.IBuffer.TransportOverride)public void extendDispose()
extendDispose in class FieldField.extendDispose()
public void extendDeflate(java.io.DataOutput out)
throws GRS2RecordSerializationException
extendDeflate in class Fieldout - the stream to deflate to
GRS2RecordSerializationException - There was a problem in the serializationField.extendDeflate(java.io.DataOutput)
public void extendToXML(org.w3c.dom.Document doc,
org.w3c.dom.Element element)
throws GRS2RecordSerializationException
extendToXML in class FieldGRS2RecordSerializationException
public void extendFromXML(org.w3c.dom.Element element,
boolean reset)
throws GRS2RecordSerializationException
extendFromXML in class FieldGRS2RecordSerializationException
public void extendInflate(java.io.DataInput in,
boolean reset)
throws GRS2RecordSerializationException
Field extenders to inflate their internal information
extendInflate in class Fieldin - the stream to inflate fromreset - whether or not the inflated information needs to be reset to clear any indication of previous executed transfers
GRS2RecordSerializationException - There was a problem in the deserializationField.extendInflate(java.io.DataInput, boolean)
public void extendReceiveFromXML(org.w3c.dom.Element element,
IBuffer.TransportOverride override)
throws GRS2RecordSerializationException
extendReceiveFromXML in class FieldGRS2RecordSerializationException
public void extendSendToXML(org.w3c.dom.Document doc,
org.w3c.dom.Element element,
IBuffer.TransportOverride override)
throws GRS2RecordSerializationException
extendSendToXML in class FieldGRS2RecordSerializationException
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||