DatatypeEnumeration (JFact 1.0.0 API)

java.lang.Object
- uk.ac.manchester.cs.jfact.datatypes.DatatypeEnumeration<R>

Type Parameters:
R -

All Implemented Interfaces:

Datatype<R>, DatatypeCombination<DatatypeEnumeration<R>,Literal<R>>, DatatypeExpression<R>, DataExpression, Entity, Expression

Direct Known Subclasses:

DatatypeNumericEnumeration
```
public class DatatypeEnumeration<R extends Comparable<R>>
extends Object
implements DatatypeCombination<DatatypeEnumeration<R>,Literal<R>>, DatatypeExpression<R>
```
Author:

ignazio

Field Summary

Fields
Modifier and Type Field and Description

protected Datatype<R> host

protected List<Literal<R>> literals

Fields
Modifier and Type	Field and Description
`protected Datatype<R>`	`host`
`protected List<Literal<R>>`	`literals`

Constructor Summary

Constructors
Constructor and Description
`DatatypeEnumeration(Datatype<R> d)`
`DatatypeEnumeration(Datatype<R> d, Collection<Literal<R>> c)`
`DatatypeEnumeration(Datatype<R> d, Literal<R> l)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`accept(DLExpressionVisitor visitor)` accept method for the visitor pattern
`<O> O`	`accept(DLExpressionVisitorEx<O> visitor)`
`DatatypeEnumeration<R>`	`add(Literal<R> d)`
`DatatypeExpression<R>`	`addNonNumericFacet(Facet f, Comparable value)` add a new facet value for this datatype expression
`DatatypeExpression<R>`	`addNumericFacet(Facet f, Comparable value)`
`DatatypeExpression<R>`	`asExpression()`
`NumericDatatype<R>`	`asNumericDatatype()`
`OrderedDatatype<R>`	`asOrderedDatatype()`
`Literal<R>`	`buildLiteral(String s)`
`boolean`	`emptyValueSpace()`
`boolean`	`equals(Object obj)`
`Collection<Datatype<?>>`	`getAncestors()`
`boolean`	`getBounded()`
`cardinality`	`getCardinality()`
`String`	`getDatatypeURI()`
`Set<Facet>`	`getFacets()`
`<O extends Comparable<O>> O`	`getFacetValue(Facet f)`
`Datatype<?>`	`getHost()`
`Datatype<R>`	`getHostType()`
`Map<Facet,Comparable>`	`getKnownNonNumericFacetValues()`
`Map<Facet,Comparable>`	`getKnownNumericFacetValues()`
`Iterable<Literal<R>>`	`getList()`
`boolean`	`getNumeric()`
`Comparable`	`getNumericFacetValue(Facet f)`
`ordered`	`getOrdered()`
`int`	`hashCode()`
`boolean`	`isCompatible(Datatype<?> type)`
`boolean`	`isCompatible(Literal<?> l)`
`boolean`	`isExpression()`
`boolean`	`isInValueSpace(R l)`
`boolean`	`isNumericDatatype()`
`boolean`	`isOrderedDatatype()`
`boolean`	`isSubType(Datatype<?> type)`
`Collection<Literal<R>>`	`listValues()`
`R`	`parseValue(String s)`
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - host
```
protected Datatype<R extends Comparable<R>> host
```
  - literals
```
protected final List<Literal<R extends Comparable<R>>> literals
```
- Constructor Detail
  - DatatypeEnumeration
```
public DatatypeEnumeration(Datatype<R> d)
```
    Parameters:
    d -
  - DatatypeEnumeration
```
public DatatypeEnumeration(Datatype<R> d,
                   Literal<R> l)
```
    Parameters:
    d -
    l -
  - DatatypeEnumeration
```
public DatatypeEnumeration(Datatype<R> d,
                   Collection<Literal<R>> c)
```
    Parameters:
    d -
    c -
- Method Detail
  - getHost
```
public Datatype<?> getHost()
```
    Specified by:
    
    getHost in interface DatatypeCombination<DatatypeEnumeration<R extends Comparable<R>>,Literal<R extends Comparable<R>>>
    
    Returns:
    the host datatype
  - add
```
public DatatypeEnumeration<R> add(Literal<R> d)
```
    Specified by:
    
    add in interface DatatypeCombination<DatatypeEnumeration<R extends Comparable<R>>,Literal<R extends Comparable<R>>>
    
    Returns:
    the type
  - listValues
```
public Collection<Literal<R>> listValues()
```
    Specified by:
    
    listValues in interface Datatype<R extends Comparable<R>>
    
    Returns:
    the list of possible values for this datatype which are compatible with the listed datatypes.
  - isExpression
```
public boolean isExpression()
```
    Specified by:
    
    isExpression in interface Datatype<R extends Comparable<R>>
    
    Returns:
    true if this datatype is an expression
  - asExpression
```
public DatatypeExpression<R> asExpression()
```
    Specified by:
    
    asExpression in interface Datatype<R extends Comparable<R>>
    
    Returns:
    this datatype as a datatype expression, if it is an expression.
  - getAncestors
```
public Collection<Datatype<?>> getAncestors()
```
    Specified by:
    
    getAncestors in interface Datatype<R extends Comparable<R>>
    
    Returns:
    the known ancestors of this datatype
  - getBounded
```
public boolean getBounded()
```
    Specified by:
    
    getBounded in interface Datatype<R extends Comparable<R>>
    
    Returns:
    true if this datatype value space is bounded
  - getCardinality
```
public cardinality getCardinality()
```
    Specified by:
    
    getCardinality in interface Datatype<R extends Comparable<R>>
    
    Returns:
    the cardinality of the value space: finite or countably infinite
  - getFacets
```
public Set<Facet> getFacets()
```
    Specified by:
    
    getFacets in interface Datatype<R extends Comparable<R>>
    
    Returns:
    the available facets for this datatype. The collection is immutable - only specs sanctioned facets allowed
  - getKnownNonNumericFacetValues
```
public Map<Facet,Comparable> getKnownNonNumericFacetValues()
```
    Specified by:
    
    getKnownNonNumericFacetValues in interface Datatype<R extends Comparable<R>>
    
    Returns:
    the known values for a subset of the available facets
  - getKnownNumericFacetValues
```
public Map<Facet,Comparable> getKnownNumericFacetValues()
```
    Specified by:
    
    getKnownNumericFacetValues in interface Datatype<R extends Comparable<R>>
    
    Returns:
    the known values for a subset of the available facets
  - getFacetValue
```
public <O extends Comparable<O>> O getFacetValue(Facet f)
```
    Specified by:
    
    getFacetValue in interface Datatype<R extends Comparable<R>>
    
    Returns:
    known value for f, or null if there is no known value for the facet
  - getNumericFacetValue
```
public Comparable getNumericFacetValue(Facet f)
```
    Specified by:
    
    getNumericFacetValue in interface Datatype<R extends Comparable<R>>
    
    Returns:
    numeric value
  - getNumeric
```
public boolean getNumeric()
```
    Specified by:
    
    getNumeric in interface Datatype<R extends Comparable<R>>
    
    Returns:
    true if this datatype is numeric
  - getOrdered
```
public ordered getOrdered()
```
    Specified by:
    
    getOrdered in interface Datatype<R extends Comparable<R>>
    
    Returns:
    the kind of ordering: false, partial or total
  - isCompatible
```
public boolean isCompatible(Literal<?> l)
```
    Specified by:
    
    isCompatible in interface Datatype<R extends Comparable<R>>
    
    Specified by:
    
    isCompatible in interface DatatypeCombination<DatatypeEnumeration<R extends Comparable<R>>,Literal<R extends Comparable<R>>>
    
    Returns:
    true if the literal is compatible
  - isInValueSpace
```
public boolean isInValueSpace(R l)
```
    Specified by:
    
    isInValueSpace in interface Datatype<R extends Comparable<R>>
    
    Returns:
    false if this literal representation does not represent a value included in the value space of this datatype; its datatype must be this datatype
  - parseValue
```
public R parseValue(String s)
```
    Specified by:
    
    parseValue in interface Datatype<R extends Comparable<R>>
    
    Parameters:
    s - parses a literal form to a value in the datatype value space; for use when building Literals
    
    Returns:
    value
  - buildLiteral
```
public Literal<R> buildLiteral(String s)
```
    Specified by:
    
    buildLiteral in interface Datatype<R extends Comparable<R>>
    
    Returns:
    a literal with parseValue(s) as typed value, generic type O equal to the internal class representing the type, and datatype this datatype.
  - isSubType
```
public boolean isSubType(Datatype<?> type)
```
    Specified by:
    
    isSubType in interface Datatype<R extends Comparable<R>>
    
    Returns:
    true if this datatype has type as an ancestor
  - getDatatypeURI
```
public String getDatatypeURI()
```
    Specified by:
    
    getDatatypeURI in interface Datatype<R extends Comparable<R>>
    
    Specified by:
    
    getDatatypeURI in interface DatatypeCombination<DatatypeEnumeration<R extends Comparable<R>>,Literal<R extends Comparable<R>>>
    
    Returns:
    the datatype uri
  - isCompatible
```
public boolean isCompatible(Datatype<?> type)
```
    Specified by:
    
    isCompatible in interface Datatype<R extends Comparable<R>>
    
    Specified by:
    
    isCompatible in interface DatatypeCombination<DatatypeEnumeration<R extends Comparable<R>>,Literal<R extends Comparable<R>>>
    
    Returns:
    true if the datatype is compatible
  - accept
```
public void accept(DLExpressionVisitor visitor)
```
    Description copied from interface: Expression
    
    accept method for the visitor pattern
    
    Specified by:
    
    accept in interface Expression
  - accept
```
public <O> O accept(DLExpressionVisitorEx<O> visitor)
```
    Specified by:
    
    accept in interface Expression
  - getList
```
public Iterable<Literal<R>> getList()
```
    Specified by:
    
    getList in interface DatatypeCombination<DatatypeEnumeration<R extends Comparable<R>>,Literal<R extends Comparable<R>>>
    
    Returns:
    list of elements
  - emptyValueSpace
```
public boolean emptyValueSpace()
```
    Specified by:
    
    emptyValueSpace in interface Datatype<R extends Comparable<R>>
    
    Specified by:
    
    emptyValueSpace in interface DatatypeCombination<DatatypeEnumeration<R extends Comparable<R>>,Literal<R extends Comparable<R>>>
    
    Returns:
    true if the value space is empty
  - isNumericDatatype
```
public boolean isNumericDatatype()
```
    Specified by:
    
    isNumericDatatype in interface Datatype<R extends Comparable<R>>
    
    Returns:
    true if the datatype is numeric
  - asNumericDatatype
```
public NumericDatatype<R> asNumericDatatype()
```
    Specified by:
    
    asNumericDatatype in interface Datatype<R extends Comparable<R>>
    
    Returns:
    cast as numeric datatype
  - isOrderedDatatype
```
public boolean isOrderedDatatype()
```
    Specified by:
    
    isOrderedDatatype in interface Datatype<R extends Comparable<R>>
    
    Returns:
    true if ordered
  - asOrderedDatatype
```
public OrderedDatatype<R> asOrderedDatatype()
```
    Specified by:
    
    asOrderedDatatype in interface Datatype<R extends Comparable<R>>
    
    Returns:
    cast as ordered datatype
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - getHostType
```
public Datatype<R> getHostType()
```
    Specified by:
    
    getHostType in interface DatatypeExpression<R extends Comparable<R>>
    
    Returns:
    the predefined datatype which is host for this expression
  - addNumericFacet
```
public DatatypeExpression<R> addNumericFacet(Facet f,
                                    Comparable value)
```
    Specified by:
    
    addNumericFacet in interface DatatypeExpression<R extends Comparable<R>>
  - addNonNumericFacet
```
public DatatypeExpression<R> addNonNumericFacet(Facet f,
                                       Comparable value)
```
    Description copied from interface: DatatypeExpression
    
    add a new facet value for this datatype expression
    
    Specified by:
    
    addNonNumericFacet in interface DatatypeExpression<R extends Comparable<R>>
    
    Parameters:
    f - a valid facet for the host datatype
    value - the value for the facet

Class DatatypeEnumeration<R extends Comparable<R>>

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

host

literals

Constructor Detail

DatatypeEnumeration

DatatypeEnumeration

DatatypeEnumeration

Method Detail

getHost

add

listValues

isExpression

asExpression

getAncestors

getBounded

getCardinality

getFacets

getKnownNonNumericFacetValues

getKnownNumericFacetValues

getFacetValue

getNumericFacetValue

getNumeric

getOrdered

isCompatible

isInValueSpace

parseValue

buildLiteral

isSubType

getDatatypeURI

isCompatible

accept

accept

getList

emptyValueSpace

isNumericDatatype

asNumericDatatype

isOrderedDatatype

asOrderedDatatype

toString

equals

hashCode

getHostType

addNumericFacet

addNonNumericFacet