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

Class StringFieldDefinition

java.lang.Object

gr.uoa.di.madgik.grs.record.field.FieldDefinition

gr.uoa.di.madgik.grs.record.field.StringFieldDefinition

All Implemented Interfaces:

Serializable

public class StringFieldDefinition
extends FieldDefinition
implements Serializable

The FieldDefinition implementation for StringField

Author:

gpapanikos

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	DefaultCharset The default charset used to encode the payload for transport.
static IBuffer.TransportDirective	DefaultDirective The default transport directive currently set to IBuffer.TransportDirective.Full
static 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

Constructors

Constructor and Description
StringFieldDefinition() Creates a new instance
StringFieldDefinition(String name) Creates a new instance

Method Summary

Methods

Modifier and Type	Method and Description
void	extendDeflate(DataOutput out) Method to be implemented by class extenders to deflate additional information
boolean	extendEquals(Object obj) Method to be implemented by extenders to check if two instances are equal
void	extendFromXML(Element element)
void	extendInflate(DataInput in) Method to be implemented by the class extenders to inflate additional information previously deflated
void	extendToXML(Document doc, Element element)
String	getCharset() Retrieves the charset name used to encode the payload
IBuffer.TransportDirective	getTransportDirective() Retrieves the transport directive to be used during transfer
void	setCharset(String charset) The charset name to use to encode the payload
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

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

Field Detail

DefaultMimeType

public static final 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

DefaultCharset

public static final String DefaultCharset

The default charset used to encode the payload for transport. Currently set to UTF-8

See Also:

Constant Field Values

Constructor Detail

StringFieldDefinition

public StringFieldDefinition()

Creates a new instance

StringFieldDefinition

public StringFieldDefinition(String name)

Creates a new instance

Parameters:

name - the field definition name

Method Detail

setCharset

public void setCharset(String charset)

The charset name to use to encode the payload

Parameters:

charset - the charset name

getCharset

public String getCharset()

Retrieves the charset name used to encode the payload

Returns:

the charset name

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(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(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(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(Document doc,
               Element element)
                 throws GRS2RecordSerializationException

Specified by:

extendToXML in class FieldDefinition

Throws:

GRS2RecordSerializationException

extendFromXML

public void extendFromXML(Element element)
                   throws GRS2RecordSerializationException

Specified by:

extendFromXML in class FieldDefinition

Throws:

GRS2RecordSerializationException