com.datalogic.device.configuration

Class PropertyGroup

java.lang.Object

com.datalogic.device.configuration.PropertyGroup

Direct Known Subclasses:

Aztec, Codabar, Code128, Code39, Code93, Composite, Datamatrix, DecodingNotification, Digimarc, Discrete25, DisplayNotification, DotCode, Ean13, Ean8, Formatting, FrameCaptureConfiguration, GoodRead, Gs1DataBar_14, Gs1DataBar_Expanded, Gs1DataBar_Limited, IntentWedge, Interleaved25, Inverse, KeyboardWedge, LinearQuietZones, Matrix25, Maxicode, Micropdf417, MicroQR, Msi, MultiScan, Pdf417, PostalAustralian, PostalJapan, PostalKix, PostalRoyalMail, PostalUsPlanet, PostalUsPostnet, PostalUsps4State, PresentationMode, QRCode, ScannerOptions, ScannerProperties, UpcA, UpcE, UpcEanExtensions, WebWedge

public class PropertyGroup
extends java.lang.Object

PropertyGroup contains properties and/or other property groups.

Constructor Summary

Constructors

Constructor and Description
PropertyGroup() This is an empty constructor, in the implementation MUST be implemented.

Method Summary

Modifier and Type	Method and Description
java.util.ArrayList<PropertyGroup>	getGroups() Returns the property groups contained in this group, not in the whole subtree.
int	getId() Gets the integer value of the unique identifier PropertyGroupID of the group.
java.lang.String	getName() Gets the name of the unique identifierPropertyGroupID of the group.
java.util.ArrayList<Property>	getProperties() Returns the properties contained in this group, not in the whole subtree.
Property	getPropertyById(int id) Gets the Property, belonging to this group's subtree, whose identifier has the given integer value in PropertyID.
Property	getPropertyByName(java.lang.String name) Gets the Property, belonging to this group's subtree, whose identifier has the integer value defined by the given string in PropertyID.
PropertyGroup	getPropertyGroupById(int id) Gets the PropertyGroup, belonging to this group's subtree, whose identifier has the given integer value in PropertyGroupID.
PropertyGroup	getPropertyGroupByName(java.lang.String name) Gets the PropertyGroup, belonging to this group's subtree, whose identifier has the integer value defined by the given string in PropertyGroupID.
boolean	isFullySupported() Deprecated. no more to be used
boolean	isSupported() Tells if this property group is supported by the underling decoding hardware.
int	load(PropertyGetter from) Deprecated. no more to be used
void	setToDefault() Resets to the default value all the properties contained in the subtree.
int	store(PropertyEditor to, boolean persist) Deprecated. no more to be used

Methods inherited from class java.lang.Object

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

Constructor Detail

PropertyGroup

public PropertyGroup()

This is an empty constructor, in the implementation MUST be implemented.

Method Detail

getProperties

public java.util.ArrayList<Property> getProperties()

Returns the properties contained in this group, not in the whole subtree.

Returns:

ArrayList of properties contained in the group.
Empty if there are no properties in this group, not in the whole subtree.

getGroups

public java.util.ArrayList<PropertyGroup> getGroups()

Returns the property groups contained in this group, not in the whole subtree.

Returns:

ArrayList of property groups contained in the group.
Empty if there are no other property groups in this group, not in the whole subtree.

getPropertyById

public Property getPropertyById(int id)

Gets the Property, belonging to this group's subtree, whose identifier has the given integer value in PropertyID. If a property with the given id is not found NULL is returned. If the returned property is not supported, get and set on the property will fail.

Parameters:

id - int unique identifier of the requested property.

Returns:

Property.

getPropertyByName

public Property getPropertyByName(java.lang.String name)

Gets the Property, belonging to this group's subtree, whose identifier has the integer value defined by the given string in PropertyID. If a property with the given name is not found NULL is returned. If the returned property is not supported, get and set on the property will fail.

Parameters:

name - String defining string of the unique identifier of the requested property.

Returns:

Property.

getPropertyGroupById

public PropertyGroup getPropertyGroupById(int id)

Gets the PropertyGroup, belonging to this group's subtree, whose identifier has the given integer value in PropertyGroupID.

Parameters:

id - int unique identifier of the requested group.

Returns:

PropertyGroup.

getPropertyGroupByName

public PropertyGroup getPropertyGroupByName(java.lang.String name)

Gets the PropertyGroup, belonging to this group's subtree, whose identifier has the integer value defined by the given string in PropertyGroupID.

Parameters:

name - String name of the requested group.

Returns:

PropertyGroup.

getName

public java.lang.String getName()

Gets the name of the unique identifierPropertyGroupID of the group.

Returns:

String.

getId

public int getId()

Gets the integer value of the unique identifier PropertyGroupID of the group.

Returns:

int.

setToDefault

public void setToDefault()

Resets to the default value all the properties contained in the subtree. To make the change persistent the ConfigurationManager.commit() must be called.

load

@Deprecated
public int load(PropertyGetter from)

Deprecated. no more to be used

Load the properties values contained by this group from the PropertyGetter.

Parameters:

from - The PropertyGetter called to synchronize the current values.

Returns:

int ConfigException.SUCCESS in case of success, otherwise a possible error code, matching one of the ConfigException error constants.

Throws:

ConfigException - in case of error, when exceptions are enabled through the ErrorManager singleton.

store

@Deprecated
public int store(PropertyEditor to,
                             boolean persist)

Deprecated. no more to be used

Store the properties values contained by this property into the PropertyEditor.

Parameters:

to - The PropertyEditor in charge of applying the desired values.

persist - boolean if true the configuration is saved in a persistent way across system reboots.

Returns:

int ConfigException.SUCCESS in case of success, otherwise a possible error code, matching one of the ConfigException error constants.

Throws:

ConfigException - in case of error, when exceptions are enabled through the ErrorManager singleton.

isSupported

public boolean isSupported()

Tells if this property group is supported by the underling decoding hardware.

Returns:

true if at least one contained property is supported by the underling decoding hardware.
If this property group doesn't contain any property, this method returns false.

isFullySupported

@Deprecated
public boolean isFullySupported()

Deprecated. no more to be used

Tells if this property group is completely supported by the underling decoding hardware.

Returns:

true if all contained property are supported by the underling decoding hardware.
If this property group doesn't contain any property, this method returns false.