org.universAAL.middleware.owl

Class LengthRestriction

java.lang.Object

org.universAAL.middleware.rdf.Resource

org.universAAL.middleware.owl.TypeExpression

org.universAAL.middleware.owl.TypeRestriction

org.universAAL.middleware.owl.LengthRestriction

Direct Known Subclasses:

Base64Restriction, StringRestriction, URIRestriction

public abstract class LengthRestriction
extends TypeRestriction

Base class for all TypeRestrictions that define a restriction on the length of a value of a given data type. Implementation of XSD Value Restrictions: it contains all literals that meet the specified conditions. These conditions are either:

1. length
2. min length
3. max length

It is possible to define a condition on the minimum length and on the maximum length in the same LengthRestriction. If minimum and maximum length are equal, only the length facet should be set.

Author:

Carsten Stockloew

Nested Class Summary

Nested classes/interfaces inherited from class org.universAAL.middleware.owl.TypeRestriction

TypeRestriction.Facet

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	XSD_FACET_LENGTH URI for the facet xsd:length.
protected static String	XSD_FACET_MAX_LENGTH URI for the facet xsd:maxLength.
protected static String	XSD_FACET_MIN_LENGTH URI for the facet xsd:minLength.

Fields inherited from class org.universAAL.middleware.owl.TypeRestriction

PROP_OWL_ON_DATATYPE, PROP_OWL_WITH_RESTRICTIONS, restrictions, XSD_FACET_PATTERN

Fields inherited from class org.universAAL.middleware.owl.TypeExpression

EXCEPTION_TTL, OWL_CLASS, OWL_NAMESPACE, PROP_RDFS_SUB_CLASS_OF, RDFS_DATATYPE, TYPE_OWL_THING

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

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	LengthRestriction(String datatypeURI) Standard constructor.

Method Summary

Modifier and Type	Method and Description
protected TypeExpression	copyTo(LengthRestriction copy) Copy the facets to a different LengthRestriction.
Object	getLen() Get the length.
Object	getMax() Get the maximum length.
protected Object	getMemberLen(Object member) Calculate the length of a member.
protected Object	getMemberValueToCheck(Object member) Calculate the value for the member that needs to be checked during TypeExpression.hasMember(Object).
Object	getMin() Get the minimum length.
protected Comparable	getNext(Comparable c) Returns the next element, i.e.
protected Comparable	getPrevious(Comparable c) Returns the previous element, i.e.
boolean	hasMember(Object member, HashMap context, int ttl, List<MatchLogEntry> log) Returns true if the given object is a member of the class represented by this type expression, otherwise false.
boolean	isDisjointWith(TypeExpression other, HashMap context, int ttl, List<MatchLogEntry> log) Not supported.
boolean	isWellFormed() Returns true, if the state of the resource is valid, otherwise false.
boolean	matches(TypeExpression subset, HashMap context, int ttl, List<MatchLogEntry> log) Returns true if the given type expression is a subset of the class represented by this type expression, otherwise false.
boolean	setLen(int len) Set the length.
boolean	setLen(NonNegativeInteger len) Set the length.
boolean	setLen(Resource len) Set the length.
boolean	setMax(int max) Set the maximum length.
boolean	setMax(NonNegativeInteger max) Set the maximum length.
boolean	setMax(Resource max) Set the maximum length.
boolean	setMin(int min) Set the minimum length.
boolean	setMin(NonNegativeInteger min) Set the minimum length.
boolean	setMin(Resource min) Set the minimum length.
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.

Methods inherited from class org.universAAL.middleware.owl.TypeRestriction

addConstrainingFacet, copyTo, getNamedSuperclasses, getTypeURI, getUpperEnumeration, hasMember, iterate, matches, resolveVarByGreaterEqual, resolveVarByLessEqual, setFacet, setPattern

Methods inherited from class org.universAAL.middleware.owl.TypeExpression

checkTTL, collectTypesMinimized, copy, getDefaultMatchmakingTTL, hasMember, hasMember, isDisjointWith, isDisjointWith, matches, matches, synchronize

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

addMultiLangProp, addType, asList, asList, asRDFList, changeProperty, copy, deepCopy, equals, generateAnonURI, getDefaultLang, getFilename, getLocalName, getMultiLangProp, getNamespace, getOrConstructLabel, getOrConstructLabel, getProperty, getPropertyURIs, getPropSerializationType, getResource, getResourceComment, getResourceLabel, getResourceLabel, getStaticFieldValue, getType, getTypes, getURI, hashCode, hasProperty, hasQualifiedName, isAnon, isAnon, isBlockingAddingTypes, isClosedCollection, isQualifiedName, literal, numberOfProperties, 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

XSD_FACET_LENGTH

protected static final String XSD_FACET_LENGTH

URI for the facet xsd:length.

XSD_FACET_MIN_LENGTH

protected static final String XSD_FACET_MIN_LENGTH

URI for the facet xsd:minLength.

XSD_FACET_MAX_LENGTH

protected static final String XSD_FACET_MAX_LENGTH

URI for the facet xsd:maxLength.

Constructor Detail

LengthRestriction

protected LengthRestriction(String datatypeURI)

Standard constructor.

Parameters:

datatypeURI - URI of the data type for which this restriction is defined. Must be one of the supported data types.

Method Detail

setLen

public boolean setLen(int len)

Set the length.

Parameters:

len - the length.

setLen

public boolean setLen(NonNegativeInteger len)

Set the length.

Parameters:

len - the length.

setLen

public boolean setLen(Resource len)

Set the length.

Parameters:

len - the length.

setMin

public boolean setMin(int min)

Set the minimum length.

Parameters:

min - the minimum length.

setMin

public boolean setMin(NonNegativeInteger min)

Set the minimum length.

Parameters:

min - the minimum length.

setMin

public boolean setMin(Resource min)

Set the minimum length.

Parameters:

min - the minimum length.

setMax

public boolean setMax(int max)

Set the maximum length.

Parameters:

max - the maximum length.

setMax

public boolean setMax(NonNegativeInteger max)

Set the maximum length.

Parameters:

max - the maximum length.

setMax

public boolean setMax(Resource max)

Set the maximum length.

Parameters:

max - the maximum length.

getLen

public Object getLen()

Get the length.

Returns:

the length, or null if not defined. Can also be a Variable reference.

getMin

public Object getMin()

Get the minimum length.

Returns:

the minimum length, or null if not defined. Can also be a Variable reference.

getMax

public Object getMax()

Get the maximum length.

Returns:

the maximum length, or null if not defined. Can also be a Variable reference.

copyTo

protected TypeExpression copyTo(LengthRestriction copy)

Copy the facets to a different LengthRestriction.

Parameters:

copy - The object to which to copy the facets.

Returns:

the value given as parameter, but with the restrictions copied.

See Also:

TypeExpression.copy()

isWellFormed

public boolean isWellFormed()

Description copied from class: TypeExpression

Returns true, if the state of the resource is valid, otherwise false. Redefined in this class as abstract to force subclasses to override it.

Specified by:

isWellFormed in class TypeExpression

See Also:

Resource.isWellFormed()

getNext

protected Comparable getNext(Comparable c)

Description copied from class: TypeRestriction

Returns the next element, i.e. the value given as parameter plus the smallest possible value that can be represented for the data type. For example, if the data type is int getNext(x) would return x+1. Sub classes should override this method.

Overrides:

getNext in class TypeRestriction

Parameters:

c - A value for which to get the next value.

Returns:

the next value.

getPrevious

protected Comparable getPrevious(Comparable c)

Description copied from class: TypeRestriction

Returns the previous element, i.e. the value given as parameter minus the smallest possible value that can be represented for the data type. For example, if the data type is int getPrevious(x) would return x-1. Sub classes should override this method.

Overrides:

getPrevious in class TypeRestriction

Parameters:

c - A value for which to get the previous value.

Returns:

the previous value.

getMemberLen

protected Object getMemberLen(Object member)

Calculate the length of a member. The default implementation just returns the length of the String value. Sub classes may override this method.

Parameters:

member - the member for which to calculate the length.

Returns:

the length as NonNegativeInteger or a Variable if the member is a Variable.

getMemberValueToCheck

protected Object getMemberValueToCheck(Object member)

Description copied from class: TypeRestriction

Calculate the value for the member that needs to be checked during TypeExpression.hasMember(Object). Sub classes may override this method.

Overrides:

getMemberValueToCheck in class TypeRestriction

Parameters:

member - the member.

Returns:

the value to check.

hasMember

public boolean hasMember(Object member,
                         HashMap context,
                         int ttl,
                         List<MatchLogEntry> log)

Description copied from class: TypeExpression

Returns true if the given object is a member of the class represented by this type expression, otherwise false. The context table maps the URIs of certain variables onto values currently assigned to them. The variables are either standard variables managed by the universAAL middleware or parameters of a specific service in whose context this method is called. Both the object whose membership is going to be checked and this type expression may contain references to such variables. If there is already a value assigned to such a referenced variable, it must be replaced by the associated value, otherwise this method may expand the context table by deriving a value for such unassigned but referenced variables with which the membership can be asserted. In case of returning true, the caller must check the size of the context table to see if new conditions are added in order for the membership to be asserted. If the context table is null, the method does a global and unconditional check.

Overrides:

hasMember in class TypeRestriction

Parameters:

member - the object whose membership is going to be checked

context - context of the matchmaking. May be null.

ttl - time-to-live parameter

log - list that can be filled with log entries. May be null.

Returns:

true if the specified member is a member of this type expression

See Also:

org.universAAL.middleware.util.Constants#VAR_ACCESSING_BUS_MEMBER, org.universAAL.middleware.util.Constants#VAR_ACCESSING_HUMAN_USER, org.universAAL.middleware.util.Constants#VAR_CURRENT_DATETIME, org.universAAL.middleware.util.Constants#VAR_SERVICE_TO_SELECT

matches

public boolean matches(TypeExpression subset,
                       HashMap context,
                       int ttl,
                       List<MatchLogEntry> log)

Description copied from class: TypeExpression

Returns true if the given type expression is a subset of the class represented by this type expression, otherwise false. The context table maps the URIs of certain variables onto values currently assigned to them. The variables are either standard variables managed by the universAAL middleware or parameters of a specific service in whose context this method is called. Both of the type expressions may contain references to such variables. If there is already a value assigned to such a referenced variable, it must be replaced by the associated value, otherwise this method may expand the context table by deriving a value for such unassigned but referenced variables with which the compatibility of the two classes can be asserted. In case of returning true, the caller must check the size of the context table to see if new conditions are added in order for the compatibility to be asserted. If the context table is null, the method does a global and unconditional check.

Specified by:

matches in class TypeExpression

Parameters:

subset - the type expression with which the compatibility is going to be checked

context - context of the matchmaking. May be null.

ttl - time-to-live parameter

log - list that can be filled with log entries. May be null.

Returns:

true if the given type expression is a subset of the class represented by this type expression, otherwise false

See Also:

org.universAAL.middleware.util.Constants#VAR_ACCESSING_BUS_MEMBER, org.universAAL.middleware.util.Constants#VAR_ACCESSING_HUMAN_USER, org.universAAL.middleware.util.Constants#VAR_CURRENT_DATETIME, org.universAAL.middleware.util.Constants#VAR_SERVICE_TO_SELECT

isDisjointWith

public boolean isDisjointWith(TypeExpression other,
                              HashMap context,
                              int ttl,
                              List<MatchLogEntry> log)

Not supported. Always returns false.

Specified by:

isDisjointWith in class TypeExpression

Parameters:

other - the type expression with which the disjointness is going to be checked

context - context of the matchmaking. May be null.

ttl - time-to-live parameter

log - list that can be filled with log entries. May be null.

Returns:

true if the given type expression has no member in common with the class represented by this type expression, otherwise false

See Also:

org.universAAL.middleware.util.Constants#VAR_ACCESSING_BUS_MEMBER, org.universAAL.middleware.util.Constants#VAR_ACCESSING_HUMAN_USER, org.universAAL.middleware.util.Constants#VAR_CURRENT_DATETIME, org.universAAL.middleware.util.Constants#VAR_SERVICE_TO_SELECT

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 TypeRestriction

Returns:

true if the property changed as a result of the call