com.whitestein.lsps.lang.exec

Class PropertyPath

java.lang.Object

com.whitestein.lsps.lang.exec.PropertyPath

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

Property

public class PropertyPath
extends Object
implements Serializable

Author:

mvo

See Also:

Serialized Form

Method Summary

Modifier and Type	Method and Description
static PropertyPath	create(RecordType recordType, List<String> properties) Creates a new property path instance.
static PropertyPath	create(RecordType recordType, String... properties) Creates a new property path instance.
boolean	equals(Object obj)
List<String>	getProperties() Returns list of properties.
RecordProperty	getRecordProperty(int index) Returns the record property corresponding to the path segment at the given index.
RecordType	getRecordType() Returns the record type.
Type	getType() Returns the path type, i.e.
Object	getValue(RecordHolder record) Returns the value of the given property path of the given record object.
int	hashCode()
boolean	isReadonly() Returns true if the property path is read-only, i.e.
void	setValue(RecordHolder record, Object value) Sets the value of the given property path of the given record object.
int	size() Returns the size of the property path (the number of path segments).
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

create

public static PropertyPath create(RecordType recordType,
                                  List<String> properties)

Creates a new property path instance.

If the size of properties list is 1, Property instance is created, if the size is greater than 1, PropertyPath instance is created.

Parameters:

recordType -

properties -

Returns:

the created instance

create

public static PropertyPath create(RecordType recordType,
                                  String... properties)

Creates a new property path instance.

If the size of properties list is 1, Property instance is created, if the size is greater than 1, PropertyPath instance is created.

Parameters:

recordType -

properties -

Returns:

the created instance

Throws:

IllegalArgumentException - if the given path is not valid

size

public int size()

Returns the size of the property path (the number of path segments).

Returns:

the size of the path

getRecordType

public RecordType getRecordType()

Returns the record type.

Returns:

the record type

getProperties

public List<String> getProperties()

Returns list of properties.

Returns:

list of properties

getType

public Type getType()

Returns the path type, i.e. the type of the last property.

Returns:

the path type

isReadonly

public boolean isReadonly()

Returns true if the property path is read-only, i.e. if the last record property is read-only or its declaration record is read-only.

Returns:

true if the property path is read-only

getRecordProperty

public RecordProperty getRecordProperty(int index)

Returns the record property corresponding to the path segment at the given index.

Parameters:

index -

Returns:

the record property

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValue

public Object getValue(RecordHolder record)
                throws ErrorException

Returns the value of the given property path of the given record object.

Parameters:

record -

Returns:

the value of the given property path

Throws:

ErrorException - If the value cannot be obtained applying this property path to the given record. The following error codes provides more detail about the problem:

• Errors.INCOMPATIBLE_TYPE_ERROR if the provided record type is incompatible with this property path record type.
• Errors.NULL_PARAMETER_ERROR if resolving the path encountered a null member before reaching the end of the path.

setValue

public void setValue(RecordHolder record,
                     Object value)
              throws ErrorException

Sets the value of the given property path of the given record object.

Parameters:

record -

value -

Throws:

ErrorException - If the value cannot be obtained applying this property path to the given record. The following error codes provides more detail about the problem:

• Errors.INCOMPATIBLE_TYPE_ERROR if the provided record type is incompatible with this property path record type.
• Errors.NULL_PARAMETER_ERROR if resolving the path encountered a null member before reaching the end of the path.
• Errors.READ_ONLY_ACCESS_ERROR if the target of this property path is read only