com.clarkparsia.pellet.datatypes.types.text

Class RestrictedTextDatatype

java.lang.Object

com.clarkparsia.pellet.datatypes.types.text.RestrictedTextDatatype

All Implemented Interfaces:

DataRange<aterm.ATermAppl>, RestrictedDatatype<aterm.ATermAppl>

public class RestrictedTextDatatype
extends Object
implements RestrictedDatatype<aterm.ATermAppl>

Title: Restricted Text Datatype

Description: A subset of the value space of rdf:plainLiteral

Copyright: Copyright (c) 2009

Company: Clark & Parsia, LLC.

Author:

Mike Smith

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	LANGUAGE
protected static String	NAME
protected static String	NCNAME
protected static String	NMTOKEN
protected static String	NORMALIZED_STRING
protected static String	TOKEN

Constructor Summary

Constructors

Constructor and Description
RestrictedTextDatatype(Datatype<aterm.ATermAppl> dt, boolean allowLang)
RestrictedTextDatatype(Datatype<aterm.ATermAppl> dt, String pattern)

Method Summary

Modifier and Type	Method and Description
static boolean	addPermittedDatatype(aterm.ATermAppl dt)
RestrictedDatatype<aterm.ATermAppl>	applyConstrainingFacet(aterm.ATermAppl facet, Object value) Apply a constraining facet to further restrict the value space
protected <T> List<T>	concatLists(List<T> l1, List<T> l2)
boolean	contains(Object value) Check if a data range contains a particular value
boolean	containsAtLeast(int n) Check that a data range contains a minimum number of elements
RestrictedDatatype<aterm.ATermAppl>	exclude(Collection<?> values) Exclude specific elements from the data range.
Datatype<? extends aterm.ATermAppl>	getDatatype() Query for the base datatype of a restricted datatype.
aterm.ATermAppl	getValue(int i) Return a value from an enumerable data range.
RestrictedDatatype<aterm.ATermAppl>	intersect(RestrictedDatatype<?> other, boolean negated) Intersect this range with another range.
boolean	isEmpty() Convenience method equivalent to !containsAtLeast(0)
boolean	isEnumerable() Query if values in the data range can be enumerated.
boolean	isFinite() Query if there are a finite number of values in the data range.
int	size() Return the size of the data range.
RestrictedDatatype<aterm.ATermAppl>	union(RestrictedDatatype<?> other) Union this range with another range.
Iterator<aterm.ATermAppl>	valueIterator() Get a (possibly infinite) iterator over values in the data range.

Methods inherited from class java.lang.Object

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

Field Detail

NCNAME

protected static final String NCNAME

See Also:

Constant Field Values

NAME

protected static final String NAME

See Also:

Constant Field Values

NMTOKEN

protected static final String NMTOKEN

See Also:

Constant Field Values

TOKEN

protected static final String TOKEN

See Also:

Constant Field Values

LANGUAGE

protected static final String LANGUAGE

See Also:

Constant Field Values

NORMALIZED_STRING

protected static final String NORMALIZED_STRING

See Also:

Constant Field Values

Constructor Detail

RestrictedTextDatatype

public RestrictedTextDatatype(Datatype<aterm.ATermAppl> dt,
                              boolean allowLang)

RestrictedTextDatatype

public RestrictedTextDatatype(Datatype<aterm.ATermAppl> dt,
                              String pattern)

Method Detail

addPermittedDatatype

public static boolean addPermittedDatatype(aterm.ATermAppl dt)

applyConstrainingFacet

public RestrictedDatatype<aterm.ATermAppl> applyConstrainingFacet(aterm.ATermAppl facet,
                                                                  Object value)
                                                           throws InvalidConstrainingFacetException

Description copied from interface: RestrictedDatatype

Apply a constraining facet to further restrict the value space

Specified by:

applyConstrainingFacet in interface RestrictedDatatype<aterm.ATermAppl>

Parameters:

facet - the constraining facet name (typically a URI)

value - the value for the constraining facet. This is not necessarily in the value space of the base datatype (e.g., length facet values on string types are not)

Returns:

the further restricted value space

Throws:

InvalidConstrainingFacetException

contains

public boolean contains(Object value)

Description copied from interface: DataRange

Check if a data range contains a particular value

Specified by:

contains in interface DataRange<aterm.ATermAppl>

Parameters:

value - the value to check

Returns:

true if the data range contains value, false else

containsAtLeast

public boolean containsAtLeast(int n)

Description copied from interface: DataRange

Check that a data range contains a minimum number of elements

Specified by:

containsAtLeast in interface DataRange<aterm.ATermAppl>

Parameters:

n - the number of elements

Returns:

true if the data range contains n or more elements, false otherwise

exclude

public RestrictedDatatype<aterm.ATermAppl> exclude(Collection<?> values)

Description copied from interface: RestrictedDatatype

Exclude specific elements from the data range. Used when a restricted data range is in a conjunction with a negative enumeration. Elements in values that are not contained in the restriction are ignored.

Specified by:

exclude in interface RestrictedDatatype<aterm.ATermAppl>

Parameters:

values - The values to exclude

Returns:

A new RestrictedDatatype

getDatatype

public Datatype<? extends aterm.ATermAppl> getDatatype()

Description copied from interface: RestrictedDatatype

Query for the base datatype of a restricted datatype. This is not necessarily a primitive datatype.

Specified by:

getDatatype in interface RestrictedDatatype<aterm.ATermAppl>

Returns:

the base datatype

getValue

public aterm.ATermAppl getValue(int i)

Description copied from interface: DataRange

Return a value from an enumerable data range. Necessary to support LiteralValueBranch shiftTryNext

Specified by:

getValue in interface DataRange<aterm.ATermAppl>

Parameters:

i - the index of the value in the data range

Returns:

the value

concatLists

protected <T> List<T> concatLists(List<T> l1,
                                  List<T> l2)

intersect

public RestrictedDatatype<aterm.ATermAppl> intersect(RestrictedDatatype<?> other,
                                                     boolean negated)

Description copied from interface: RestrictedDatatype

Intersect this range with another range. It must be the case that getDatatype().getPrimitiveDatatype().equals( other.getDatatype.getPrimiveDatatype()

Specified by:

intersect in interface RestrictedDatatype<aterm.ATermAppl>

Parameters:

other - restricted datatype to merge into this

negated - true if other is negated, false else

Returns:

a new RestrictedDatatype, representing the intersection of this and other

isEmpty

public boolean isEmpty()

Description copied from interface: DataRange

Convenience method equivalent to !containsAtLeast(0)

Specified by:

isEmpty in interface DataRange<aterm.ATermAppl>

Returns:

true if the data range contains no elements, false otherwise

isEnumerable

public boolean isEnumerable()

Description copied from interface: DataRange

Query if values in the data range can be enumerated.

Specified by:

isEnumerable in interface DataRange<aterm.ATermAppl>

Returns:

true if the data range is enumerable, false otherwise

isFinite

public boolean isFinite()

Description copied from interface: DataRange

Query if there are a finite number of values in the data range.

Specified by:

isFinite in interface DataRange<aterm.ATermAppl>

Returns:

true if the data range is finite, false otherwise

size

public int size()

Description copied from interface: DataRange

Return the size of the data range. Necessary to support LiteralValueBranch constructor

Specified by:

size in interface DataRange<aterm.ATermAppl>

Returns:

the size of the data range

union

public RestrictedDatatype<aterm.ATermAppl> union(RestrictedDatatype<?> other)

Description copied from interface: RestrictedDatatype

Union this range with another range. It must be the case that getDatatype().getPrimitiveDatatype().equals( other.getDatatype.getPrimiveDatatype()

Specified by:

union in interface RestrictedDatatype<aterm.ATermAppl>

Parameters:

other - restricted datatype to merge with this

Returns:

a new RestrictedDatatype, representing the intersection of this and other

valueIterator

public Iterator<aterm.ATermAppl> valueIterator()

Description copied from interface: DataRange

Get a (possibly infinite) iterator over values in the data range.

Specified by:

valueIterator in interface DataRange<aterm.ATermAppl>

Returns:

an Iterator