com.whitestein.lsps.stdlib.function

Class PropertyFunctions

java.lang.Object

com.whitestein.lsps.stdlib.function.PropertyFunctions

public class PropertyFunctions
extends Object

Property functions.

Author:

mvo

Constructor Summary

Constructors

Constructor and Description
PropertyFunctions()

Method Summary

Modifier and Type	Method and Description
ListHolder	getProperties(ExecutionContext ctx, Type type) Returns the properties of the given record type.
Property	getProperty(ExecutionContext ctx, Type type, String name) Returns a property with a given name or null if there is no property with a given name.
MapHolder	getPropertyMetadata(ExecutionContext ctx, Property property) Returns the property metadata.
String	getPropertyName(ExecutionContext ctx, Property property) Returns a property name (a name of the field or association).
ListHolder	getPropertyNames(ExecutionContext ctx, PropertyPath propertyPath) Returns the list of property names.
RecordType	getPropertyPathRecordType(ExecutionContext ctx, PropertyPath propertyPath) Returns the property path record type.
Type	getPropertyPathType(ExecutionContext ctx, PropertyPath propertyPath) Returns the property path type (the type of the last property).
Object	getPropertyPathValue(ExecutionContext ctx, RecordHolder record, PropertyPath propertyPath) Returns the value of the given property path of the given record object.
RecordType	getPropertyRecordType(ExecutionContext ctx, Property property) Returns the record type in which this property is declared.
ReferenceHolder	getPropertyReference(ExecutionContext ctx, ReferenceHolder reference, Property... properties) Returns the reference to the object defined by the last property parameter.
Type	getPropertyType(ExecutionContext ctx, Property property) Returns a property type.
Object	getPropertyValue(ExecutionContext ctx, RecordHolder record, Property property) Returns the value of the given property of the given record object.
boolean	isAutogenerated(ExecutionContext ctx, Property property) Returns true if the property is autogenerated.
boolean	isPrimaryKey(ExecutionContext ctx, Property property) Returns true if this property is a part of the primary key.
boolean	isReadOnly(ExecutionContext ctx, PropertyPath propertyPath) Returns true if the property path is read-only.
boolean	isVersion(ExecutionContext ctx, Property property) Returns true if the property is a version field.
void	setPropertyPathValue(ExecutionContext ctx, RecordHolder record, PropertyPath propertyPath, Object value) Sets the value of the given property path of the given record object.
Object	setPropertyValue(ExecutionContext ctx, RecordHolder record, Property property, Object value) Sets the value of the given property of the given record object.

Methods inherited from class java.lang.Object

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

Constructor Detail

PropertyFunctions

public PropertyFunctions()

Method Detail

getProperty

public Property getProperty(ExecutionContext ctx,
                            Type type,
                            String name)
                     throws ErrorException

Returns a property with a given name or null if there is no property with a given name.

Parameters:

ctx -

type -

name -

Returns:

a property or null

Throws:

ErrorException

getPropertyName

public String getPropertyName(ExecutionContext ctx,
                              Property property)
                       throws ErrorException

Returns a property name (a name of the field or association).

Parameters:

ctx -

property -

Returns:

a property name

Throws:

ErrorException

getPropertyType

public Type getPropertyType(ExecutionContext ctx,
                            Property property)
                     throws ErrorException

Returns a property type. It is a type of the record field (or association).

Parameters:

ctx -

property -

Returns:

a property type

Throws:

ErrorException

getPropertyRecordType

public RecordType getPropertyRecordType(ExecutionContext ctx,
                                        Property property)
                                 throws ErrorException

Returns the record type in which this property is declared.

Parameters:

ctx -

property -

Returns:

the record type in which this property is declared

Throws:

ErrorException

getPropertyMetadata

public MapHolder getPropertyMetadata(ExecutionContext ctx,
                                     Property property)
                              throws ErrorException

Returns the property metadata.

Parameters:

ctx -

property -

Returns:

the property metadata

Throws:

ErrorException

getPropertyValue

public Object getPropertyValue(ExecutionContext ctx,
                               RecordHolder record,
                               Property property)
                        throws ErrorException

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

Parameters:

ctx -

record -

property -

Returns:

the value of the given property

Throws:

ErrorException

setPropertyValue

public Object setPropertyValue(ExecutionContext ctx,
                               RecordHolder record,
                               Property property,
                               Object value)
                        throws ErrorException

Sets the value of the given property of the given record object. Returns null.

Parameters:

ctx -

record -

property -

value -

Returns:

null

Throws:

ErrorException

getProperties

public ListHolder getProperties(ExecutionContext ctx,
                                Type type)
                         throws ErrorException

Returns the properties of the given record type.

Parameters:

ctx -

type -

Returns:

the properties of the given record type

Throws:

ErrorException

getPropertyReference

public ReferenceHolder getPropertyReference(ExecutionContext ctx,
                                            ReferenceHolder reference,
                                            Property... properties)
                                     throws ErrorException

Returns the reference to the object defined by the last property parameter. The path to the object is resolved as a chain of associations starting in the reference parameter through the property parameters in specified order.

Parameters:

ctx -

reference -

properties -

Returns:

reference to the property of the object referenced by the provided reference

Throws:

ErrorException

getPropertyNames

public ListHolder getPropertyNames(ExecutionContext ctx,
                                   PropertyPath propertyPath)
                            throws ErrorException

Returns the list of property names.

Parameters:

ctx -

propertyPath -

Returns:

the list of property names

Throws:

ErrorException

getPropertyPathType

public Type getPropertyPathType(ExecutionContext ctx,
                                PropertyPath propertyPath)
                         throws ErrorException

Returns the property path type (the type of the last property).

Parameters:

ctx -

propertyPath -

Returns:

the property path type

Throws:

ErrorException

getPropertyPathRecordType

public RecordType getPropertyPathRecordType(ExecutionContext ctx,
                                            PropertyPath propertyPath)
                                     throws ErrorException

Returns the property path record type. It is the record type where the given property path starts.

Parameters:

ctx -

propertyPath -

Returns:

the property path record type

Throws:

ErrorException

getPropertyPathValue

public Object getPropertyPathValue(ExecutionContext ctx,
                                   RecordHolder record,
                                   PropertyPath propertyPath)
                            throws ErrorException

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

Parameters:

ctx -

record -

propertyPath -

Returns:

the value of the given property path

Throws:

ErrorException

setPropertyPathValue

public void setPropertyPathValue(ExecutionContext ctx,
                                 RecordHolder record,
                                 PropertyPath propertyPath,
                                 Object value)
                          throws ErrorException

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

Parameters:

ctx -

record -

propertyPath -

value -

Throws:

ErrorException

isReadOnly

public boolean isReadOnly(ExecutionContext ctx,
                          PropertyPath propertyPath)
                   throws ErrorException

Returns true if the property path is read-only.

Parameters:

ctx -

propertyPath -

Returns:

true if the property path is read-only

Throws:

ErrorException

isPrimaryKey

public boolean isPrimaryKey(ExecutionContext ctx,
                            Property property)
                     throws ErrorException

Returns true if this property is a part of the primary key.

Parameters:

ctx -

property -

Returns:

true if this property is a part of the primary key

Throws:

ErrorException

isAutogenerated

public boolean isAutogenerated(ExecutionContext ctx,
                               Property property)
                        throws ErrorException

Returns true if the property is autogenerated.

Parameters:

ctx -

property -

Returns:

true if the property is autogenerated

Throws:

ErrorException

isVersion

public boolean isVersion(ExecutionContext ctx,
                         Property property)
                  throws ErrorException

Returns true if the property is a version field.

Parameters:

ctx -

property -

Returns:

true if the property is a version field

Throws:

ErrorException