ConstantType (psl-core 2.3.0 API)

java.lang.Object
- java.lang.Enum<ConstantType>
- - org.linqs.psl.model.term.ConstantType

All Implemented Interfaces:

Serializable, Comparable<ConstantType>
```
public enum ConstantType
extends Enum<ConstantType>
```
A type of Constant.
The enumerated types of ConstantType are used to identify different subtypes of Constant.

Enum Constant Summary

Enum Constants
Enum Constant and Description
`DeferredFunctionalUniqueID` A special type of unique identifier to only be used by functional predicates in special situations.
`Double` A `DoubleAttribute` argument.
`Integer` An `IntegerAttribute` argument.
`Long` A `Long` argument.
`String` A `StringAttribute` argument.
`UniqueIntID` A `UniqueIntID` argument.
`UniqueStringID` A `UniqueStringID` argument.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`static Constant`	`getConstant(String value, ConstantType type)` Convert a general string into the appropriate Constant.
`abstract String`	`getName()`
`static ConstantType`	`getType(Constant term)`
`abstract boolean`	`isInstance(Constant term)` Returns whether a GroundTerm is of the type identified by this ArgumentType
`static ConstantType`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static ConstantType[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

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

- Enum Constant Detail
  - String
```
public static final ConstantType String
```
    A StringAttribute argument.
  - Integer
```
public static final ConstantType Integer
```
    An IntegerAttribute argument.
  - Double
```
public static final ConstantType Double
```
    A DoubleAttribute argument.
  - Long
```
public static final ConstantType Long
```
    A Long argument.
  - UniqueIntID
```
public static final ConstantType UniqueIntID
```
    A UniqueIntID argument. A unique identifier that is explicitly an int. Will generally perform faster than a UniqueStringID.
  - UniqueStringID
```
public static final ConstantType UniqueStringID
```
    A UniqueStringID argument. A unique identifier that is explicitly a String. Will generally perform slower than a UniqueIntID.
  - DeferredFunctionalUniqueID
```
public static final ConstantType DeferredFunctionalUniqueID
```
    A special type of unique identifier to only be used by functional predicates in special situations. This is to be used only when the exact type of unique id must be deferred until actual computation time. STRONGLY prefer UniqueIntID or UniqueStringID over this.
- Method Detail
  - values
```
public static ConstantType[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
```
for (ConstantType c : ConstantType.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static ConstantType valueOf(String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
    
    Parameters:
    
    name - the name of the enum constant to be returned.
    
    Returns:
    
    the enum constant with the specified name
    
    Throws:
    
    IllegalArgumentException - if this enum type has no constant with the specified name
    
    NullPointerException - if the argument is null
  - getName
```
public abstract String getName()
```
    Returns:
    
    a human-friendly String identifier for this ArgumentType
  - isInstance
```
public abstract boolean isInstance(Constant term)
```
    Returns whether a GroundTerm is of the type identified by this ArgumentType
    
    Parameters:
    
    term - the term to check
    
    Returns:
    
    TRUE if term is an instance of the corresponding type
  - getType
```
public static ConstantType getType(Constant term)
```
  - getConstant
```
public static Constant getConstant(String value,
                                   ConstantType type)
```
    Convert a general string into the appropriate Constant.

Enum ConstantType

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

String

Integer

Double

Long

UniqueIntID

UniqueStringID

DeferredFunctionalUniqueID

Method Detail

values

valueOf

getName

isInstance

getType

getConstant