org.rabbitcontrol.rcp.model

Class Parameter

java.lang.Object

org.rabbitcontrol.rcp.model.Parameter

All Implemented Interfaces:

IParameter, RCPWritable

Direct Known Subclasses:

BangParameter, GroupParameter, ValueParameter

public abstract class Parameter
extends java.lang.Object
implements IParameter

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Parameter.PARAMETER_UPDATED
static interface	Parameter.PARAMETER_VALUE_UPDATED

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	description
protected short	id
protected boolean	initialWrite
protected java.lang.String	label
protected java.util.Map<java.lang.String,java.lang.String>	languageDescriptions
protected java.util.Map<java.lang.String,java.lang.String>	languageLabels
protected java.lang.Integer	order
protected java.lang.String	tags
protected TypeDefinition	typeDefinition
protected byte[]	userdata

Constructor Summary

Constructors

Constructor and Description
Parameter(short _id, TypeDefinition _typeDefinition)

Method Summary

Modifier and Type	Method and Description
void	addUpdateListener(Parameter.PARAMETER_UPDATED _listener)
void	addValueUpdateListener(Parameter.PARAMETER_VALUE_UPDATED _listener)
protected void	callValueUpdateListener()
void	clearLangaugeDescription()
void	clearLanguageLabel()
void	clearUpdateListener()
void	clearValueUpdateListener()
IParameter	cloneEmpty()
void	dump()
java.lang.String	getDescription()
java.util.Set<java.lang.String>	getDescriptionLanguages()
short	getId()
java.lang.String	getLabel()
java.util.Set<java.lang.String>	getLabelLanguages()
java.lang.String	getLanguageDescription(java.lang.String _code)
java.lang.String	getLanguageLabel(java.lang.String _code)
java.lang.Integer	getOrder()
GroupParameter	getParent()
boolean	getReadonly()
java.lang.String	getTags()
ITypeDefinition	getTypeDefinition()
byte[]	getUserdata()
java.lang.String	getUserid()
Widget	getWidget()
protected abstract boolean	handleOption(int _propertyId, io.kaitai.struct.KaitaiStream _io)
boolean	hasPendingParents()
boolean	onlyValueChanged()
static Parameter	parse(io.kaitai.struct.KaitaiStream _io, IParameterManager _manager)
protected void	parseTypeOptions(io.kaitai.struct.KaitaiStream _io)
static Parameter	parseValueUpdate(io.kaitai.struct.KaitaiStream _io)
void	removeLanguageDescription(java.lang.String _code)
void	removeLanguageLabel(java.lang.String _code)
void	removeUpdateListener(Parameter.PARAMETER_UPDATED _listener)
void	removeValueUpdateListener(Parameter.PARAMETER_VALUE_UPDATED _listener)
void	resolvePendingParents() try to resolve all unresolved parents
void	setDescription(java.lang.String _description)
void	setDirty()
void	setLabel(java.lang.String _label)
void	setLanguageDescription(java.lang.String _code, java.lang.String _label)
void	setLanguageLabel(java.lang.String _code, java.lang.String _label)
void	setManager(IParameterManager _model)
void	setOrder(int _order)
void	setParent(GroupParameter _parent)
void	setReadonly(boolean _readonly)
void	setTags(java.lang.String _tags)
void	setUserdata(byte[] _userdata)
void	setUserid(java.lang.String _userid)
void	setWidget(Widget _widget)
void	update(IParameter _parameter)
void	write(java.io.OutputStream _outputStream, boolean _all)
protected void	writeId(short _id, java.io.OutputStream _outputStream)
void	writeOptions(java.io.OutputStream _outputStream, boolean _all)
void	writeUpdateValue(java.io.OutputStream _outputStream)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.rabbitcontrol.rcp.model.interfaces.IParameter

getStringValue, setStringValue

Field Detail

id

protected final short id

typeDefinition

protected final TypeDefinition typeDefinition

label

protected java.lang.String label

languageLabels

protected java.util.Map<java.lang.String,java.lang.String> languageLabels

description

protected java.lang.String description

languageDescriptions

protected java.util.Map<java.lang.String,java.lang.String> languageDescriptions

tags

protected java.lang.String tags

order

protected java.lang.Integer order

userdata

protected byte[] userdata

initialWrite

protected boolean initialWrite

Constructor Detail

Parameter

public Parameter(short _id,
                 TypeDefinition _typeDefinition)

Method Detail

parse

public static Parameter parse(io.kaitai.struct.KaitaiStream _io,
                              IParameterManager _manager)
                       throws RCPUnsupportedFeatureException,
                              RCPDataErrorException

Throws:

RCPUnsupportedFeatureException

RCPDataErrorException

parseValueUpdate

public static Parameter parseValueUpdate(io.kaitai.struct.KaitaiStream _io)
                                  throws RCPUnsupportedFeatureException,
                                         RCPDataErrorException

Throws:

RCPUnsupportedFeatureException

RCPDataErrorException

cloneEmpty

public IParameter cloneEmpty()

onlyValueChanged

public boolean onlyValueChanged()

Specified by:

onlyValueChanged in interface IParameter

handleOption

protected abstract boolean handleOption(int _propertyId,
                                        io.kaitai.struct.KaitaiStream _io)
                                 throws RCPDataErrorException

Throws:

RCPDataErrorException

parseTypeOptions

protected void parseTypeOptions(io.kaitai.struct.KaitaiStream _io)
                         throws RCPDataErrorException

Throws:

RCPDataErrorException

writeId

protected void writeId(short _id,
                       java.io.OutputStream _outputStream)
                throws java.io.IOException

Throws:

java.io.IOException

writeUpdateValue

public void writeUpdateValue(java.io.OutputStream _outputStream)
                      throws java.io.IOException,
                             RCPException

Throws:

java.io.IOException

RCPException

writeOptions

public void writeOptions(java.io.OutputStream _outputStream,
                         boolean _all)
                  throws java.io.IOException,
                         RCPException

Throws:

java.io.IOException

RCPException

write

public final void write(java.io.OutputStream _outputStream,
                        boolean _all)
                 throws java.io.IOException,
                        RCPException

Specified by:

write in interface RCPWritable

Throws:

java.io.IOException

RCPException

update

public void update(IParameter _parameter)
            throws RCPException

Throws:

RCPException

dump

public void dump()

Specified by:

dump in interface IParameter

addUpdateListener

public void addUpdateListener(Parameter.PARAMETER_UPDATED _listener)

Specified by:

addUpdateListener in interface IParameter

removeUpdateListener

public void removeUpdateListener(Parameter.PARAMETER_UPDATED _listener)

Specified by:

removeUpdateListener in interface IParameter

clearUpdateListener

public void clearUpdateListener()

Specified by:

clearUpdateListener in interface IParameter

addValueUpdateListener

public void addValueUpdateListener(Parameter.PARAMETER_VALUE_UPDATED _listener)

Specified by:

addValueUpdateListener in interface IParameter

removeValueUpdateListener

public void removeValueUpdateListener(Parameter.PARAMETER_VALUE_UPDATED _listener)

Specified by:

removeValueUpdateListener in interface IParameter

clearValueUpdateListener

public void clearValueUpdateListener()

Specified by:

clearValueUpdateListener in interface IParameter

callValueUpdateListener

protected void callValueUpdateListener()

getId

public short getId()

Specified by:

getId in interface IParameter

getTypeDefinition

public ITypeDefinition getTypeDefinition()

Specified by:

getTypeDefinition in interface IParameter

getLabel

public java.lang.String getLabel()

Specified by:

getLabel in interface IParameter

setLabel

public void setLabel(java.lang.String _label)

Specified by:

setLabel in interface IParameter

getLabelLanguages

public java.util.Set<java.lang.String> getLabelLanguages()

Specified by:

getLabelLanguages in interface IParameter

getLanguageLabel

public java.lang.String getLanguageLabel(java.lang.String _code)

Specified by:

getLanguageLabel in interface IParameter

clearLanguageLabel

public void clearLanguageLabel()

Specified by:

clearLanguageLabel in interface IParameter

setLanguageLabel

public void setLanguageLabel(java.lang.String _code,
                             java.lang.String _label)

Specified by:

setLanguageLabel in interface IParameter

removeLanguageLabel

public void removeLanguageLabel(java.lang.String _code)

Specified by:

removeLanguageLabel in interface IParameter

getDescription

public java.lang.String getDescription()

Specified by:

getDescription in interface IParameter

setDescription

public void setDescription(java.lang.String _description)

Specified by:

setDescription in interface IParameter

getDescriptionLanguages

public java.util.Set<java.lang.String> getDescriptionLanguages()

Specified by:

getDescriptionLanguages in interface IParameter

getLanguageDescription

public java.lang.String getLanguageDescription(java.lang.String _code)

Specified by:

getLanguageDescription in interface IParameter

clearLangaugeDescription

public void clearLangaugeDescription()

Specified by:

clearLangaugeDescription in interface IParameter

setLanguageDescription

public void setLanguageDescription(java.lang.String _code,
                                   java.lang.String _label)

Specified by:

setLanguageDescription in interface IParameter

removeLanguageDescription

public void removeLanguageDescription(java.lang.String _code)

Specified by:

removeLanguageDescription in interface IParameter

getTags

public java.lang.String getTags()

Specified by:

getTags in interface IParameter

setTags

public void setTags(java.lang.String _tags)

Specified by:

setTags in interface IParameter

getOrder

public java.lang.Integer getOrder()

Specified by:

getOrder in interface IParameter

setOrder

public void setOrder(int _order)

Specified by:

setOrder in interface IParameter

getParent

public GroupParameter getParent()

Specified by:

getParent in interface IParameter

setParent

public void setParent(GroupParameter _parent)

Specified by:

setParent in interface IParameter

resolvePendingParents

public void resolvePendingParents()

try to resolve all unresolved parents

hasPendingParents

public boolean hasPendingParents()

getWidget

public Widget getWidget()

Specified by:

getWidget in interface IParameter

setWidget

public void setWidget(Widget _widget)

Specified by:

setWidget in interface IParameter

getUserid

public java.lang.String getUserid()

Specified by:

getUserid in interface IParameter

setUserid

public void setUserid(java.lang.String _userid)

Specified by:

setUserid in interface IParameter

getUserdata

public byte[] getUserdata()

Specified by:

getUserdata in interface IParameter

setUserdata

public void setUserdata(byte[] _userdata)

Specified by:

setUserdata in interface IParameter

getReadonly

public boolean getReadonly()

Specified by:

getReadonly in interface IParameter

setReadonly

public void setReadonly(boolean _readonly)

Specified by:

setReadonly in interface IParameter

setManager

public void setManager(IParameterManager _model)

Specified by:

setManager in interface IParameter

setDirty

public void setDirty()

Specified by:

setDirty in interface IParameter