Package org.epics.pvdata.factory

Class BasePVStructure

java.lang.Object

org.epics.pvdata.factory.AbstractPVField

org.epics.pvdata.factory.BasePVStructure

All Implemented Interfaces:

BitSetSerializable, PVField, PVStructure, Serializable

public class BasePVStructure
extends AbstractPVField
implements PVStructure

Base class for a PVStructure.

Author:

mrk

Field Summary

Fields inherited from class org.epics.pvdata.factory.AbstractPVField

convert

Constructor Summary

Constructors

Constructor	Description
BasePVStructure(Structure structure)	Constructor.
BasePVStructure(Structure structure, PVField[] pvFields)	Constructor.

Method Summary

Modifier and Type	Method	Description
boolean	checkValid()	Check if PVStructure and sub fields are valid.
void	deserialize(ByteBuffer buffer, DeserializableControl control)	Deserialize buffer.
void	deserialize(ByteBuffer buffer, DeserializableControl control, BitSet bitSet)	Deserialize buffer.
boolean	equals(Object obj)
PVBoolean	getBooleanField(String fieldName)	Find a boolean subfield with the specified fieldName.
PVByte	getByteField(String fieldName)	Find a byte subfield with the specified fieldName.
PVDouble	getDoubleField(String fieldName)	Find a double subfield with the specified fieldName.
PVFloat	getFloatField(String fieldName)	Find a float subfield with the specified fieldName.
PVInt	getIntField(String fieldName)	Find an int subfield with the specified fieldName.
PVLong	getLongField(String fieldName)	Find a long subfield with the specified fieldName.
PVField[]	getPVFields()	Get the PVField array for the nodes of the structure.
PVScalarArray	getScalarArrayField(String fieldName, ScalarType elementType)	Find an array subfield with the specified fieldName and elementType.
PVShort	getShortField(String fieldName)	Find a short subfield with the specified fieldName.
PVString	getStringField(String fieldName)	Find a string subfield with the specified fieldName.
Structure	getStructure()	Get the Structure introspection interface.
PVStructureArray	getStructureArrayField(String fieldName)	Find a structureArray subfield with the specified fieldName.
PVStructure	getStructureField(String fieldName)	Find a structure subfield with the specified fieldName
PVField	getSubField(int fieldOffset)	Get the PVField with the specified offset.
<T extends PVField> T	getSubField(Class<T> c, int fieldOffset)	Get the PVField with the specified offset.
<T extends PVField> T	getSubField(Class<T> c, String fieldName)	Get the PVField subfield with name fieldName.
PVField	getSubField(String fieldName)	Get the PVField subfield with name fieldName.
PVUnionArray	getUnionArrayField(String fieldName)	Find a unionArray subfield with the specified fieldName.
PVUnion	getUnionField(String fieldName)	Find a union subfield with the specified fieldName.
int	hashCode()
void	serialize(ByteBuffer buffer, SerializableControl flusher)	Serialize field into given buffer.
void	serialize(ByteBuffer buffer, SerializableControl flusher, BitSet bitSet)	Serialize field into the given buffer.
void	setImmutable()	Set the field to be immutable - that is, it can no longer be modified.

Methods inherited from class org.epics.pvdata.factory.AbstractPVField

changeField, getField, getFieldName, getFieldOffset, getFullName, getNextFieldOffset, getNumberFields, getParent, isImmutable, postPut, setData, setPostHandler, toString, toString, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.epics.pvdata.pv.PVField

getField, getFieldName, getFieldOffset, getFullName, getNextFieldOffset, getNumberFields, getParent, isImmutable, postPut, setPostHandler, toString, toString, toString

Constructor Detail

BasePVStructure

public BasePVStructure(Structure structure)

Constructor.

Parameters:

structure - the reflection interface for the PVStructure data.

BasePVStructure

public BasePVStructure(Structure structure,
                       PVField[] pvFields)

Constructor.

Parameters:

structure - the reflection interface for the PVStructure data.

pvFields - The PVField array for the subfields.

Method Detail

setImmutable

public void setImmutable()

Description copied from interface: PVField

Set the field to be immutable - that is, it can no longer be modified. This is permanent. Once done the field cannot be made mutable.

Specified by:

setImmutable in interface PVField

Overrides:

setImmutable in class AbstractPVField

getSubField

public PVField getSubField(String fieldName)

Description copied from interface: PVStructure

Get the PVField subfield with name fieldName.

fieldName is the name of the field relative to this PVStructure. So it consists of one or more strings separated by periods (.s). The last of these strings is the name of the field. The other strings are the names of the structure subfields containing the requested field starting with the highest-level subfield and descending to the leaf field, e.g. current.alarm.status.

Specified by:

getSubField in interface PVStructure

Parameters:

fieldName - the fieldName

Returns:

the PVField or null if the subfield does not exist

getSubField

public PVField getSubField(int fieldOffset)

Description copied from interface: PVStructure

Get the PVField with the specified offset.

Specified by:

getSubField in interface PVStructure

Parameters:

fieldOffset - the offset

Returns:

the PVField or null if the offset is not part of this structure

getStructure

public Structure getStructure()

Description copied from interface: PVStructure

Get the Structure introspection interface.

Specified by:

getStructure in interface PVStructure

Returns:

the introspection interface

getPVFields

public PVField[] getPVFields()

Description copied from interface: PVStructure

Get the PVField array for the nodes of the structure.

Specified by:

getPVFields in interface PVStructure

Returns:

array of PVField, one for each field

getBooleanField

public PVBoolean getBooleanField(String fieldName)

Description copied from interface: PVStructure

Find a boolean subfield with the specified fieldName.

fieldName is the full name of the field relative to this PVStructure.

Specified by:

getBooleanField in interface PVStructure

Parameters:

fieldName - the name of the field to find

Returns:

the interface if the field of the correct type is found or null otherwise

getByteField

public PVByte getByteField(String fieldName)

Description copied from interface: PVStructure

Find a byte subfield with the specified fieldName.

fieldName is the full name of the field relative to this PVStructure.

Specified by:

getByteField in interface PVStructure

Parameters:

fieldName - the name of the field to find

Returns:

the interface if the field of the correct type is found or null if not found

getShortField

public PVShort getShortField(String fieldName)

Description copied from interface: PVStructure

Find a short subfield with the specified fieldName.

fieldName is the full name of the field relative to this PVStructure.

Specified by:

getShortField in interface PVStructure

Parameters:

fieldName - the name of the field to find.

Returns:

the interface if the field of the correct type is found or null otherwise

getIntField

public PVInt getIntField(String fieldName)

Description copied from interface: PVStructure

Find an int subfield with the specified fieldName.

fieldName is the full name of the field relative to this PVStructure.

Specified by:

getIntField in interface PVStructure

Parameters:

fieldName - the name of the field to find

Returns:

the interface if the field of the correct type is found or null if not found

getSubField

public <T extends PVField> T getSubField(Class<T> c,
                                         String fieldName)

Description copied from interface: PVStructure

Get the PVField subfield with name fieldName.

fieldName is the name of the field relative to this PVStructure. So it consists of one or more strings separated by periods (.s). The last of these strings is the name of the field. The other strings are the names of the structure subfields containing the requested field starting with the highest-level subfield and descending to the leaf field, e.g. current.alarm.status.

Specified by:

getSubField in interface PVStructure

Type Parameters:

T - the expected type of the PVField of the requested field

Parameters:

c - class object modeling the class T of expected type of the requested field

fieldName - the fieldName.

Returns:

the PVField or null if the subfield does not exist, or the field is not of type T

getSubField

public <T extends PVField> T getSubField(Class<T> c,
                                         int fieldOffset)

Description copied from interface: PVStructure

Get the PVField with the specified offset.

Specified by:

getSubField in interface PVStructure

Type Parameters:

T - the expected type of the PVField of the requested field

Parameters:

c - class object modeling the class T of expected type of the requested field

fieldOffset - the offset

Returns:

the PVField or null if the offset is not part of this structure, or the field is not of type T

getLongField

public PVLong getLongField(String fieldName)

Description copied from interface: PVStructure

Find a long subfield with the specified fieldName.

fieldName is the full name of the field relative to this PVStructure.

Specified by:

getLongField in interface PVStructure

Parameters:

fieldName - the name of the field to find.

Returns:

the interface if the field of the correct type is found or null otherwise

getFloatField

public PVFloat getFloatField(String fieldName)

Description copied from interface: PVStructure

Find a float subfield with the specified fieldName.

fieldName is the full name of the field relative to this PVStructure.

Specified by:

getFloatField in interface PVStructure

Parameters:

fieldName - the name of the field to find

Returns:

the interface if the field of the correct type is found or null otherwise

getDoubleField

public PVDouble getDoubleField(String fieldName)

Description copied from interface: PVStructure

Find a double subfield with the specified fieldName.

fieldName is the full name of the field relative to this PVStructure.

Specified by:

getDoubleField in interface PVStructure

Parameters:

fieldName - the name of the field to find

Returns:

the interface if the field of the correct type is found or null otherwise

getStringField

public PVString getStringField(String fieldName)

Description copied from interface: PVStructure

Find a string subfield with the specified fieldName.

fieldName is the full name of the field relative to this PVStructure.

Specified by:

getStringField in interface PVStructure

Parameters:

fieldName - the name of the field to find

Returns:

the interface if the field of the correct type is found or null otherwise

getStructureField

public PVStructure getStructureField(String fieldName)

Description copied from interface: PVStructure

Find a structure subfield with the specified fieldName

fieldName is the full name of the field relative to this PVStructure.

Specified by:

getStructureField in interface PVStructure

Parameters:

fieldName - The field name to find.

Returns:

the interface if the field of the correct type is found or null otherwise

getUnionField

public PVUnion getUnionField(String fieldName)

Description copied from interface: PVStructure

Find a union subfield with the specified fieldName.

fieldName is the full name of the field relative to this PVStructure.

Specified by:

getUnionField in interface PVStructure

Parameters:

fieldName - the field name to find

Returns:

the interface if the field of the correct type is found or null otherwise

getScalarArrayField

public PVScalarArray getScalarArrayField(String fieldName,
                                         ScalarType elementType)

Description copied from interface: PVStructure

Find an array subfield with the specified fieldName and elementType.

fieldName is the full name of the field relative to this PVStructure.

Specified by:

getScalarArrayField in interface PVStructure

Parameters:

fieldName - the name of the field to find

elementType - the ScalarType of an element of the ScalarArray field

Returns:

the interface if the field of the correct type is found or null otherwise

getStructureArrayField

public PVStructureArray getStructureArrayField(String fieldName)

Description copied from interface: PVStructure

Find a structureArray subfield with the specified fieldName.

fieldName is the full name of the field relative to this PVStructure.

Specified by:

getStructureArrayField in interface PVStructure

Parameters:

fieldName - the name of the field to find

Returns:

the interface if the field of the correct type is found or null if not found

getUnionArrayField

public PVUnionArray getUnionArrayField(String fieldName)

Description copied from interface: PVStructure

Find a unionArray subfield with the specified fieldName.

fieldName is the full name of the field relative to this PVStructure.

Specified by:

getUnionArrayField in interface PVStructure

Parameters:

fieldName - The field name to find

Returns:

the interface if the field of the correct type is found or null otherwise

checkValid

public boolean checkValid()

Description copied from interface: PVStructure

Check if PVStructure and sub fields are valid.

Specified by:

checkValid in interface PVStructure

Returns:

(true,false) if (OK, problems found)

serialize

public void serialize(ByteBuffer buffer,
                      SerializableControl flusher)

Description copied from interface: Serializable

Serialize field into given buffer.

Specified by:

serialize in interface Serializable

Parameters:

buffer - the serialization buffer

flusher - the flush interface

deserialize

public void deserialize(ByteBuffer buffer,
                        DeserializableControl control)

Description copied from interface: Serializable

Deserialize buffer.

Specified by:

deserialize in interface Serializable

Parameters:

buffer - the serialization buffer

control - the deserialization control

deserialize

public void deserialize(ByteBuffer buffer,
                        DeserializableControl control,
                        BitSet bitSet)

Description copied from interface: BitSetSerializable

Deserialize buffer.

Specified by:

deserialize in interface BitSetSerializable

Parameters:

buffer - serialization buffer

control - deserialization control instance

bitSet - the BitSet which shows the fields to deserialize

serialize

public void serialize(ByteBuffer buffer,
                      SerializableControl flusher,
                      BitSet bitSet)

Description copied from interface: BitSetSerializable

Serialize field into the given buffer.

Specified by:

serialize in interface BitSetSerializable

Parameters:

buffer - serialization buffer

flusher - flush interface

bitSet - the BitSet which shows the fields to serialize

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object