Role (Pellet :: Core 2.5.2-dllearner API)

java.lang.Object
- org.mindswap.pellet.Role

```
public class Role
extends Object
```
Title:

Description:

Copyright: Copyright (c) 2007

Company: Clark & Parsia, LLC.

Author:

Evren Sirin

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ANNOTATION` Deprecated.
`static int`	`ANTI_SYM` Use `ASYM`
`static int`	`ASYM`
`static int`	`COMPLEX_SUB`
`static int`	`DATATYPE` Deprecated.
`static int`	`FORCE_SIMPLE`
`static int`	`FUNCTIONAL`
`static int`	`INV_FUNCTIONAL`
`static int`	`IRREFLEXIVE`
`static int`	`OBJECT` Deprecated.
`static int`	`ONTOLOGY` Deprecated.
`static int`	`REFLEXIVE`
`static int`	`SIMPLE`
`static int`	`TRANSITIVE`
`static String[]`	`TYPES` Deprecated.
`static int`	`UNTYPED` Deprecated.

Constructor Summary

Constructors
Constructor and Description

Role(aterm.ATermAppl name)

Role(aterm.ATermAppl name, PropertyType type)

Constructors
Constructor and Description
`Role(aterm.ATermAppl name)`
`Role(aterm.ATermAppl name, PropertyType type)`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addDisjointRole(Role r, DependencySet ds)`
`boolean`	`addDomain(aterm.ATermAppl a, DependencySet ds)`
`void`	`addFunctionalSuper(Role r)`
`boolean`	`addRange(aterm.ATermAppl a, DependencySet ds)`
`void`	`addSubRole(Role r)` r is subrole of this role
`void`	`addSubRole(Role r, DependencySet ds)` Add sub role with depedency set.
`void`	`addSubRoleChain(aterm.ATermList chain)` Add a sub role chain without dependency tracking information
`void`	`addSubRoleChain(aterm.ATermList chain, DependencySet ds)` Add a sub role chain with dependency tracking.
`void`	`addSuperRole(Role r)` r is superrole of this role
`void`	`addSuperRole(Role r, DependencySet ds)`
`void`	`addTransitiveSubRole(Role r)`
`String`	`debugString()`
`boolean`	`equals(Object o)`
`Set<Role>`	`getDisjointRoles()`
`Set<aterm.ATermAppl>`	`getDomains()`
`Set<Role>`	`getEquivalentProperties()`
`DependencySet`	`getExplainAsymmetric()`
`DependencySet`	`getExplainDisjointRole(Role role)`
`DependencySet`	`getExplainDomain(aterm.ATermAppl a)`
`DependencySet`	`getExplainFunctional()`
`DependencySet`	`getExplainInverseFunctional()`
`DependencySet`	`getExplainIrreflexive()`
`DependencySet`	`getExplainRange(aterm.ATermAppl a)`
`DependencySet`	`getExplainReflexive()`
`DependencySet`	`getExplainSub(aterm.ATerm r)`
`DependencySet`	`getExplainSubOrInv(Role r)`
`DependencySet`	`getExplainSuper(aterm.ATerm r)`
`DependencySet`	`getExplainSymmetric()`
`DependencySet`	`getExplainTransitive()`
`TransitionGraph<Role>`	`getFSM()`
`Set<Role>`	`getFunctionalSupers()`
`Role`	`getInverse()`
`aterm.ATermAppl`	`getName()`
`Set<Role>`	`getProperSubRoles()`
`Set<aterm.ATermAppl>`	`getRanges()`
`Set<aterm.ATermList>`	`getSubRoleChains()`
`Set<Role>`	`getSubRoles()`
`Set<Role>`	`getSuperRoles()`
`Set<Role>`	`getTransitiveSubRoles()`
`PropertyType`	`getType()`
`String`	`getTypeName()`
`boolean`	`hasComplexSubRole()`
`int`	`hashCode()`
`boolean`	`hasNamedInverse()`
`boolean`	`isAnnotationRole()` check if a role is declared as datatype property
`boolean`	`isAnon()`
`boolean`	`isAntisymmetric()` Deprecated. Use `isAsymmetric()`
`boolean`	`isAsymmetric()`
`boolean`	`isBottom()`
`boolean`	`isBuiltin()`
`boolean`	`isDatatypeRole()`
`boolean`	`isEquivalent(Role r)`
`boolean`	`isForceSimple()`
`boolean`	`isFunctional()`
`boolean`	`isInverseFunctional()`
`boolean`	`isIrreflexive()`
`boolean`	`isObjectRole()`
`boolean`	`isOntologyRole()` Deprecated.
`boolean`	`isReflexive()`
`boolean`	`isSimple()`
`boolean`	`isSubRoleOf(Role r)`
`boolean`	`isSuperRoleOf(Role r)`
`boolean`	`isSymmetric()`
`boolean`	`isTop()`
`boolean`	`isTransitive()`
`boolean`	`isUntypedRole()`
`boolean`	`removeDomain(aterm.ATermAppl a, DependencySet ds)`
`boolean`	`removeRange(aterm.ATermAppl a, DependencySet ds)`
`void`	`removeSubRole(Role r)`
`void`	`removeSubRoleChain(aterm.ATermList chain)`
`void`	`removeSubRoleChains()`
`void`	`setAntisymmetric(boolean b)` Deprecated. Use `setAsymmetric(boolean)`
`void`	`setAntisymmetric(boolean b, DependencySet ds)` Deprecated. Use `setAsymmetric(boolean,DependencySet)`
`void`	`setAsymmetric(boolean b)`
`void`	`setAsymmetric(boolean b, DependencySet ds)`
`void`	`setForceSimple(boolean b)`
`void`	`setFSM(TransitionGraph<Role> tg)`
`void`	`setFunctional(boolean b)`
`void`	`setFunctional(boolean b, DependencySet ds)`
`void`	`setHasComplexSubRole(boolean b)`
`void`	`setInverse(Role term)`
`void`	`setInverseFunctional(boolean b)`
`void`	`setInverseFunctional(boolean b, DependencySet ds)`
`void`	`setIrreflexive(boolean b)`
`void`	`setIrreflexive(boolean b, DependencySet ds)`
`void`	`setReflexive(boolean b)`
`void`	`setReflexive(boolean b, DependencySet ds)`
`void`	`setSubRolesAndChains(Set<Role> subRoles, Set<aterm.ATermList> subRoleChains, Map<aterm.ATerm,DependencySet> dependencies)`
`void`	`setSuperRoles(Set<Role> superRoles)`
`void`	`setTransitive(boolean b)`
`void`	`setTransitive(boolean b, DependencySet ds)`
`void`	`setType(PropertyType type)`
`String`	`toString()`

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

Field Detail

TYPES

@Deprecated
public static final String[] TYPES

Deprecated.

UNTYPED
```
@Deprecated
public static final int UNTYPED
```
Deprecated.

See Also:

Constant Field Values

OBJECT
```
@Deprecated
public static final int OBJECT
```
Deprecated.

See Also:

Constant Field Values

DATATYPE
```
@Deprecated
public static final int DATATYPE
```
Deprecated.

See Also:

Constant Field Values

ANNOTATION
```
@Deprecated
public static final int ANNOTATION
```
Deprecated.

See Also:

Constant Field Values

ONTOLOGY
```
@Deprecated
public static final int ONTOLOGY
```
Deprecated.

See Also:

Constant Field Values

TRANSITIVE
```
public static int TRANSITIVE
```

FUNCTIONAL
```
public static int FUNCTIONAL
```

INV_FUNCTIONAL
```
public static int INV_FUNCTIONAL
```

REFLEXIVE
```
public static int REFLEXIVE
```

IRREFLEXIVE
```
public static int IRREFLEXIVE
```

ASYM
```
public static int ASYM
```

ANTI_SYM
```
public static int ANTI_SYM
```
Use ASYM

SIMPLE
```
public static int SIMPLE
```

COMPLEX_SUB
```
public static int COMPLEX_SUB
```

FORCE_SIMPLE
```
public static int FORCE_SIMPLE
```

Constructor Detail

Role
```
public Role(aterm.ATermAppl name)
```

Role

public Role(aterm.ATermAppl name,
            PropertyType type)

Method Detail

equals
```
public boolean equals(Object o)
```
Overrides:

equals in class Object

hashCode
```
public int hashCode()
```
Overrides:

hashCode in class Object

toString
```
public String toString()
```
Overrides:

toString in class Object

debugString
```
public String debugString()
```

addSubRoleChain
```
public void addSubRoleChain(aterm.ATermList chain)
```
Add a sub role chain without dependency tracking information

Parameters:

chain -

addSubRoleChain

public void addSubRoleChain(aterm.ATermList chain,
                            DependencySet ds)

Add a sub role chain with dependency tracking.

Parameters:: chain - List of role names of at least length 2.; ds -

removeSubRoleChain

public void removeSubRoleChain(aterm.ATermList chain)

removeSubRoleChains
```
public void removeSubRoleChains()
```

addSubRole
```
public void addSubRole(Role r)
```
r is subrole of this role

Parameters:

r -

addSubRole

public void addSubRole(Role r,
                       DependencySet ds)

Add sub role with depedency set.

Parameters:: r - subrole of this role; ds -

removeDomain

public boolean removeDomain(aterm.ATermAppl a,
                            DependencySet ds)

removeRange

public boolean removeRange(aterm.ATermAppl a,
                           DependencySet ds)

removeSubRole
```
public void removeSubRole(Role r)
```

addSuperRole
```
public void addSuperRole(Role r)
```
r is superrole of this role

Parameters:

r -

addSuperRole

public void addSuperRole(Role r,
                         DependencySet ds)

addDisjointRole

public void addDisjointRole(Role r,
                            DependencySet ds)

addDomain

public boolean addDomain(aterm.ATermAppl a,
                         DependencySet ds)

addRange

public boolean addRange(aterm.ATermAppl a,
                        DependencySet ds)

isObjectRole
```
public boolean isObjectRole()
```

isDatatypeRole
```
public boolean isDatatypeRole()
```

isOntologyRole

@Deprecated
public boolean isOntologyRole()

Deprecated.

isAnnotationRole
```
public boolean isAnnotationRole()
```
check if a role is declared as datatype property

isUntypedRole
```
public boolean isUntypedRole()
```

getInverse
```
public Role getInverse()
```
Returns:

hasNamedInverse
```
public boolean hasNamedInverse()
```

hasComplexSubRole
```
public boolean hasComplexSubRole()
```

isFunctional
```
public boolean isFunctional()
```

isInverseFunctional
```
public boolean isInverseFunctional()
```

isSymmetric
```
public boolean isSymmetric()
```

isAntisymmetric
```
public boolean isAntisymmetric()
```
Deprecated. Use isAsymmetric()

isAsymmetric
```
public boolean isAsymmetric()
```

isTransitive
```
public boolean isTransitive()
```

isReflexive
```
public boolean isReflexive()
```

isIrreflexive
```
public boolean isIrreflexive()
```

isAnon
```
public boolean isAnon()
```

getName
```
public aterm.ATermAppl getName()
```

getDomains

public Set<aterm.ATermAppl> getDomains()

getRanges

public Set<aterm.ATermAppl> getRanges()

getSubRoles
```
public Set<Role> getSubRoles()
```

getEquivalentProperties

public Set<Role> getEquivalentProperties()

isEquivalent
```
public boolean isEquivalent(Role r)
```

getProperSubRoles
```
public Set<Role> getProperSubRoles()
```

getSubRoleChains

public Set<aterm.ATermList> getSubRoleChains()

getSuperRoles
```
public Set<Role> getSuperRoles()
```
Returns:

getDisjointRoles
```
public Set<Role> getDisjointRoles()
```

getExplainDisjointRole

public DependencySet getExplainDisjointRole(Role role)

getType
```
public PropertyType getType()
```
Returns:

getTypeName
```
public String getTypeName()
```

isSubRoleOf
```
public boolean isSubRoleOf(Role r)
```

isSuperRoleOf
```
public boolean isSuperRoleOf(Role r)
```

setInverse
```
public void setInverse(Role term)
```

setFunctional
```
public void setFunctional(boolean b)
```

setFunctional

public void setFunctional(boolean b,
                          DependencySet ds)

setInverseFunctional

public void setInverseFunctional(boolean b)

setInverseFunctional

public void setInverseFunctional(boolean b,
                                 DependencySet ds)

setTransitive
```
public void setTransitive(boolean b)
```

setTransitive

public void setTransitive(boolean b,
                          DependencySet ds)

setReflexive
```
public void setReflexive(boolean b)
```

setReflexive

public void setReflexive(boolean b,
                         DependencySet ds)

setIrreflexive

public void setIrreflexive(boolean b)

setIrreflexive

public void setIrreflexive(boolean b,
                           DependencySet ds)

setAntisymmetric
```
public void setAntisymmetric(boolean b)
```
Deprecated. Use setAsymmetric(boolean)

setAsymmetric
```
public void setAsymmetric(boolean b)
```

setAntisymmetric

public void setAntisymmetric(boolean b,
                             DependencySet ds)

Deprecated. Use setAsymmetric(boolean,DependencySet)

setAsymmetric

public void setAsymmetric(boolean b,
                          DependencySet ds)

setHasComplexSubRole

public void setHasComplexSubRole(boolean b)

setType

public void setType(PropertyType type)

setSubRolesAndChains

public void setSubRolesAndChains(Set<Role> subRoles,
                                 Set<aterm.ATermList> subRoleChains,
                                 Map<aterm.ATerm,DependencySet> dependencies)

Parameters:: subRoleChains -; dependencies - map from role names (or lists) to depedencies

setSuperRoles
```
public void setSuperRoles(Set<Role> superRoles)
```
Parameters:

superRoles - The superRoles to set.

dependencies - A map from role names (or role lists) to dependency sets.

getFunctionalSupers
```
public Set<Role> getFunctionalSupers()
```
Returns:

Returns the functionalSuper.

addFunctionalSuper
```
public void addFunctionalSuper(Role r)
```
Parameters:

functionalSuper - The functionalSuper to set.

setForceSimple

public void setForceSimple(boolean b)

isForceSimple
```
public boolean isForceSimple()
```

isSimple
```
public boolean isSimple()
```

getTransitiveSubRoles
```
public Set<Role> getTransitiveSubRoles()
```
Returns:

Returns transitive sub roles.

addTransitiveSubRole
```
public void addTransitiveSubRole(Role r)
```
Parameters:

r - The transtive sub role to add.

setFSM

public void setFSM(TransitionGraph<Role> tg)

getFSM
```
public TransitionGraph<Role> getFSM()
```

getExplainAsymmetric

public DependencySet getExplainAsymmetric()

getExplainDomain

public DependencySet getExplainDomain(aterm.ATermAppl a)

getExplainFunctional

public DependencySet getExplainFunctional()

getExplainInverseFunctional

public DependencySet getExplainInverseFunctional()

getExplainIrreflexive

public DependencySet getExplainIrreflexive()

getExplainRange

public DependencySet getExplainRange(aterm.ATermAppl a)

getExplainReflexive

public DependencySet getExplainReflexive()

getExplainSub

public DependencySet getExplainSub(aterm.ATerm r)

getExplainSubOrInv

public DependencySet getExplainSubOrInv(Role r)

getExplainSuper

public DependencySet getExplainSuper(aterm.ATerm r)

getExplainSymmetric

public DependencySet getExplainSymmetric()

getExplainTransitive

public DependencySet getExplainTransitive()

isTop
```
public boolean isTop()
```

isBottom
```
public boolean isBottom()
```

isBuiltin
```
public boolean isBuiltin()
```

Class Role

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

TYPES

UNTYPED

OBJECT

DATATYPE

ANNOTATION

ONTOLOGY

TRANSITIVE

FUNCTIONAL

INV_FUNCTIONAL

REFLEXIVE

IRREFLEXIVE

ASYM

ANTI_SYM

SIMPLE

COMPLEX_SUB

FORCE_SIMPLE

Constructor Detail

Role

Role

Method Detail

equals

hashCode

toString

debugString

addSubRoleChain

addSubRoleChain

removeSubRoleChain

removeSubRoleChains

addSubRole

addSubRole

removeDomain

removeRange

removeSubRole

addSuperRole

addSuperRole

addDisjointRole

addDomain

addRange

isObjectRole

isDatatypeRole

isOntologyRole

isAnnotationRole

isUntypedRole

getInverse

hasNamedInverse

hasComplexSubRole

isFunctional

isInverseFunctional

isSymmetric

isAntisymmetric

isAsymmetric

isTransitive

isReflexive

isIrreflexive

isAnon

getName

getDomains

getRanges

getSubRoles

getEquivalentProperties

isEquivalent

getProperSubRoles

getSubRoleChains

getSuperRoles

getDisjointRoles

getExplainDisjointRole

getType

getTypeName

isSubRoleOf

isSuperRoleOf

setInverse

setFunctional

setFunctional

setInverseFunctional