Package pulse.util

Class PropertyHolder

java.lang.Object

pulse.util.UpwardsNavigable

pulse.util.Group

pulse.util.Accessible

pulse.util.PropertyHolder

All Implemented Interfaces:

Serializable, Descriptive

Direct Known Subclasses:

AbsorptionModel, AbstractData, AbstractIntegrator, Baseline, Buffer, Calculation, CorrelationTest, DifferenceScheme, Discretisation, Grid, Harmonic, IterativeSolver, LinearOptimiser, Metadata, ODEIntegrator, OptimisablePolyline, PathOptimiser, Problem, Pulse, PulseTemporalShape, RadiativeTransferCoupling, RadiativeTransferSolver, Range, Statistic, StretchedGrid, ThermalProperties

public abstract class PropertyHolder
extends Accessible

An Accessible that has a list of parameters it accepts as its own and a list of PropertyHolderListener that track changes with all properties of the Accessible.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
PropertyHolder()

Method Summary

Modifier and Type	Method	Description
void	addListener(PropertyHolderListener l)
boolean	areDetailsHidden()	By default, this is set to false.
List<Property>	data()	Lists all data contained in this PropertyHolder.
String	describe()	Uses the SearchTask id (if present) to describe this UpwardsNavigable.
void	firePropertyChanged(Object source, Property property)
String	getDescriptor()	If not null, will return the prefix, otherwise calls the superclass method.
List<PropertyHolderListener>	getListeners()
String	getPrefix()
boolean	ignoreSiblings()	Should Accessibles that belong to this PropertyHolder be ignored when this PropertyHolder is displayed in a table?
void	initListeners()
boolean	isListedNumericType(NumericPropertyKeyword p)
boolean	isListedParameter(Property p)	Checks whether p, which is either a generic or a numeric property, is listed as as parameter for this PropertyHolder.
Set<NumericPropertyKeyword>	listedKeywords()	By default, this will search the children of this PropertyHolder to collect the types of their listed numeric parameters recursively.
List<Property>	listedTypes()	By default, collects a list of default properties corresponding to types defined by listedKeywords().
List<NumericProperty>	numericData()	Lists all numeric data contained in this PropertyHolder.
void	parameterListChanged()
void	removeListeners()
void	setPrefix(String prefix)
void	updateProperties(Object sourceComponent, PropertyHolder propertyHolder)	This method will update this PropertyHolder with all properties that are contained in a different propertyHolder, if they also are present in the former.
boolean	updateProperty(Object sourceComponent, Property updatedProperty)	Attempts to update an updatedProperty similar to one found in this PropertyHolder.

Methods inherited from class pulse.util.Accessible

accessibleChildren, genericProperties, genericProperty, numericProperties, numericProperty, property, set, update, update

Methods inherited from class pulse.util.Group

access, children, contents, getSimpleName, subgroups

Methods inherited from class pulse.util.UpwardsNavigable

addHierarchyListener, getHierarchyListeners, getParent, identify, removeHierarchyListener, removeHierarchyListeners, setParent, specificAncestor, tellParent

Methods inherited from class java.lang.Object

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

Constructor Detail

PropertyHolder

public PropertyHolder()

Method Detail

listedKeywords

public Set<NumericPropertyKeyword> listedKeywords()

By default, this will search the children of this PropertyHolder to collect the types of their listed numeric parameters recursively.

Returns:

a set of NumericPropertyKeyword instances, which have been explicitly marked as a listed parameter for this PropertyHolder.

listedTypes

public List<Property> listedTypes()

By default, collects a list of default properties corresponding to types defined by listedKeywords(). However, this method is overridable to include non-numeric properties.

Returns:

a list of Property instances, which have been explicitly marked as a listed parameter for this PropertyHolder.

initListeners

public void initListeners()

Overrides:

initListeners in class UpwardsNavigable

isListedNumericType

public boolean isListedNumericType(NumericPropertyKeyword p)

isListedParameter

public boolean isListedParameter(Property p)

Checks whether p, which is either a generic or a numeric property, is listed as as parameter for this PropertyHolder.

Parameters:

p - the Property

Returns:

true if p is listed, false otherwise.

data

public List<Property> data()

Lists all data contained in this PropertyHolder. The data objects must satisfy the following conditions: (a) they must be explicitly listed; (b) the corresponding property must not be auto-adjustable if the details need to remain hidden.

Returns:

a list of data, which combines generic and numeric properties.

numericData

public List<NumericProperty> numericData()

Lists all numeric data contained in this PropertyHolder. The data objects must satisfy the following conditions: (a) they must be explicitly listed; (b) the corresponding property must not be auto-adjustable if the details need to remain hidden.

Returns:

a list of Property data.

See Also:

areDetailsHidden(), isListedNumericType(pulse.properties.NumericProperty)

updateProperty

public boolean updateProperty(Object sourceComponent,
                              Property updatedProperty)

Attempts to update an updatedProperty similar to one found in this PropertyHolder. The call originator is declared to be the sourceComponent. If the originator is not the parent of this UpwardsNavigable, this object will tell their parent about this behaviour. The update is done by calling the superclass method update(Property -- if and only if a property similar to updatedProperty exists and its value is not equal to the updatedProperty. When the update happens, this will pass the corresponding PropertyEvent to the available listeners.

Parameters:

sourceComponent - the originator of the change.

updatedProperty - the updated property that will be assigned to this PropertyHolder.

firePropertyChanged

public void firePropertyChanged(Object source,
                                Property property)

updateProperties

public void updateProperties(Object sourceComponent,
                             PropertyHolder propertyHolder)

This method will update this PropertyHolder with all properties that are contained in a different propertyHolder, if they also are present in the former.

Parameters:

sourceComponent - the source of the change

propertyHolder - another PropertyHolder

See Also:

updateProperty(java.lang.Object,pulse.properties.Property)

removeListeners

public void removeListeners()

addListener

public void addListener(PropertyHolderListener l)

getListeners

public List<PropertyHolderListener> getListeners()

areDetailsHidden

public boolean areDetailsHidden()

By default, this is set to false. If the overriding subclass sets this to true, only those NumericProperties that have the autoAdjustable flag set false will be shown.

Returns:

true if the auto-adjustable numeric properties need to stay hidden, false otherwise.

parameterListChanged

public void parameterListChanged()

ignoreSiblings

public boolean ignoreSiblings()

Should Accessibles that belong to this PropertyHolder be ignored when this PropertyHolder is displayed in a table?

Returns:

false by default

See Also:

PropertyHolderTable

describe

public String describe()

Description copied from class: UpwardsNavigable

Uses the SearchTask id (if present) to describe this UpwardsNavigable.

Specified by:

describe in interface Descriptive

Overrides:

describe in class UpwardsNavigable

Returns:

by default, this will return the name of the implementing class and the date of the calculation.

getPrefix

public String getPrefix()

getDescriptor

public String getDescriptor()

If not null, will return the prefix, otherwise calls the superclass method.

Overrides:

getDescriptor in class Group

Returns:

the descriptor

See Also:

Group.getSimpleName()

setPrefix

public void setPrefix(String prefix)