org.universAAL.middleware.service

Class AggregationFunction

java.lang.Object

org.universAAL.middleware.rdf.Resource

org.universAAL.middleware.rdf.FinalizedResource

org.universAAL.middleware.service.AggregationFunction

public final class AggregationFunction
extends FinalizedResource

The AggregationFunction class includes the required functions in the SELECT clause of a the SPARQL-like query.

Author:

mtazari - Saied Tazari

Field Summary

Fields

Modifier and Type	Field and Description
static int	MAX_DISTANCE_TO_REF_LOC
static int	MAX_OF
static AggregationFunction	maxDistanceToRefLoc
static AggregationFunction	maxOf
static int	MIN_DISTANCE_TO_REF_LOC
static int	MIN_OF
static AggregationFunction	minDistanceToRefLoc
static AggregationFunction	minOf
static String	MY_URI
static int	ONE_OF
static AggregationFunction	oneOf

Fields inherited from class org.universAAL.middleware.rdf.Resource

ANON_URI_PREFIX, blockAddingTypes, isXMLLiteral, NAMESPACE_PREFIX, ns_delim_index, PROP_INVOLVED_HUMAN_USER, PROP_RDF_FIRST, PROP_RDF_REST, PROP_RDF_TYPE, PROP_RDFS_COMMENT, PROP_RDFS_LABEL, PROP_SERIALIZATION_FULL, PROP_SERIALIZATION_OPTIONAL, PROP_SERIALIZATION_REDUCED, PROP_SERIALIZATION_UNDEFINED, props, RDF_EMPTY_LIST, RDF_NAMESPACE, RDFS_NAMESPACE, SERVICE_NAMESPACE, TYPE_RDF_LIST, TYPE_RDFS_CLASS, uri, VOCABULARY_NAMESPACE

Method Summary

Modifier and Type	Method and Description
static AggregationFunction	getAggregationFunctionByOrder(int order) Returns the order value of the AggregationFunction.
int	getNumberOfParams() Returns the number of parameters that must be given when using this instance of AggregationFunction.
String	getParameterType(int i) Returns the type of the parameter that is needed for this AggregationFunction.
int	getPropSerializationType(String propURI) Answers if the given property has to be considered when serializing this individual in a minimized way, and if not ignore-able, whether its value should be presented in its full form or can be reduced.
boolean	isWellFormed() Returns true, if the state of the resource is valid, otherwise false.
String	name() Returns the human-readable name of this AggregationFunction.
int	ord() Returns the number of the order value(integer).
boolean	setProperty(String propURI, Object o) Adds a statement with this resource as the subject, the given propURI as the predicate and the given value as the object.
static AggregationFunction	valueOf(String name) Returns the value of the AggregationFunction.

Methods inherited from class org.universAAL.middleware.rdf.FinalizedResource

addType, getLocalName, getNamespace, getProperty, getPropertyURIs, getType, getTypes, getURI, hasQualifiedName, isAnon, numberOfProperties

Methods inherited from class org.universAAL.middleware.rdf.Resource

addMultiLangProp, asList, asList, asRDFList, changeProperty, copy, deepCopy, equals, generateAnonURI, getDefaultLang, getFilename, getMultiLangProp, getOrConstructLabel, getOrConstructLabel, getResource, getResourceComment, getResourceLabel, getResourceLabel, getStaticFieldValue, hashCode, hasProperty, isAnon, isBlockingAddingTypes, isClosedCollection, isQualifiedName, literal, representsQualifiedURI, serializesAsXMLLiteral, setPropertyPath, setPropertyPath, setPropertyPathFromOffset, setResourceComment, setResourceLabel, toString, toStringRecursive, toStringRecursive, unliteral

Methods inherited from class java.lang.Object

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

Field Detail

MY_URI

public static final String MY_URI

See Also:

Constant Field Values

ONE_OF

public static final int ONE_OF

See Also:

Constant Field Values

MIN_OF

public static final int MIN_OF

See Also:

Constant Field Values

MAX_OF

public static final int MAX_OF

See Also:

Constant Field Values

MIN_DISTANCE_TO_REF_LOC

public static final int MIN_DISTANCE_TO_REF_LOC

See Also:

Constant Field Values

MAX_DISTANCE_TO_REF_LOC

public static final int MAX_DISTANCE_TO_REF_LOC

See Also:

Constant Field Values

oneOf

public static final AggregationFunction oneOf

minOf

public static final AggregationFunction minOf

maxOf

public static final AggregationFunction maxOf

minDistanceToRefLoc

public static final AggregationFunction minDistanceToRefLoc

maxDistanceToRefLoc

public static final AggregationFunction maxDistanceToRefLoc

Method Detail

getAggregationFunctionByOrder

public static AggregationFunction getAggregationFunctionByOrder(int order)

Returns the order value of the AggregationFunction. Depending on the inserted parameter, it returns only one of the predefined values for the number of services.

Parameters:

order -

valueOf

public static final AggregationFunction valueOf(String name)

Returns the value of the AggregationFunction. It returns the predefined names for the AggregationFunction of services.

Parameters:

name - can get null or the VOCABULARY_NAMESPACE value

getPropSerializationType

public int getPropSerializationType(String propURI)

Description copied from class: Resource

Answers if the given property has to be considered when serializing this individual in a minimized way, and if not ignore-able, whether its value should be presented in its full form or can be reduced. The return value must be one of Resource.PROP_SERIALIZATION_OPTIONAL, Resource.PROP_SERIALIZATION_REDUCED, or Resource.PROP_SERIALIZATION_FULL. It can be assumed that the given property is one of those returned by Resource.getPropertyURIs().
Decision criterion should be if the value of this property is absolutely necessary when this resource is being sent to a remote node. If the subclass rates it as unlikely that the receiver side would need this info, the answer should be PROP_SERIALIZATION_OPTIONAL in favor of lower communication traffic and higher performance even at risk of a possible additional query on the receiver side for fetching this info. With the same rationale, if a property should be included in the process of serialization, it is preferable to include it in a reduced form; in this case the return value should be PROP_SERIALIZATION_REDUCED, otherwise PROP_SERIALIZATION_FULL can be returned. Subclasses should normally overwrite this method as this default implementation returns always PROP_SERIALIZATION_FULL.

Overrides:

getPropSerializationType in class Resource

Parameters:

propURI - the URI of the property

See Also:

Resource.getPropSerializationType(String propURI)

isWellFormed

public boolean isWellFormed()

Returns true, if the state of the resource is valid, otherwise false.

Overrides:

isWellFormed in class Resource

name

public String name()

Returns the human-readable name of this AggregationFunction.

getNumberOfParams

public int getNumberOfParams()

Returns the number of parameters that must be given when using this instance of AggregationFunction.

getParameterType

public String getParameterType(int i)

Returns the type of the parameter that is needed for this AggregationFunction.

Parameters:

i - the index of the parameter.

Returns:

URI of the type of the parameter. The first parameter is always a PropertyPath, the second parameter is always an AbsLocation.

See Also:

PropertyPath, AbsLocation

ord

public int ord()

Returns the number of the order value(integer).

setProperty

public boolean setProperty(String propURI,
                           Object o)

Description copied from class: Resource

Adds a statement with this resource as the subject, the given propURI as the predicate and the given value as the object. Subclasses must override this in order to decide if the statement to be added fits the general class constraints. If not, the call of this method should be ignored. For each property only one single call may be made to this method, unless subsequent calls to this method for setting the value of the same property are treated as an update for an update-able property. Multi-valued properties must be set using an instance of List. The differentiation, if a such list should be treated as an rdf:List, can be made with the help of Resource.isClosedCollection(String). The default implementation here accepts all property-value pairs blindly except for rdf:type which is handled if the value is a type URI, a Resource or a java.util.List of them.

Note: The setting of the property rdf:type is being handled by this class via the final methods Resource.addType(String, boolean), Resource.getType(), and Resource.getTypes(). Although these methods give the view of handling type URIs as strings, but in reality the types are stored as direct instances of this class. So, the subclasses should ignore calls for setting rdf:type; if not, then the subclass must pay attention that the value should be a List of direct instances of this class so that (1) the Resource.toString() method returns just the URI and (2) the serializers get no problems with the value. Also, settings via subclasses may be overwritten by this class if a subsequent call to Resource.addType(String, boolean) is made.

Overrides:

setProperty in class Resource

Returns:

true if the property changed as a result of the call

See Also:

Resource.setProperty(String propURI, Object value)