org.dishevelled.vocabulary
Interface Authority

All Known Implementing Classes:

SimpleAuthority

public interface Authority

An authority for a structured vocabulary domain, a mapping between domains, and/or assignments to concepts.

Version:

$Revision$ $Date$

Author:

Michael Heuer

Method Summary

Assignment	createAssignment(Concept concept, Assignable assignable, java.util.Set<Evidence> evidence) Create a new assignment maintained by this authority of concept to assignable, supported by evidence (optional operation).
Domain	createDomain(java.lang.String name) Create a new domain maintained by this authority with the specified name (optional operation).
Mapping	createMapping(Domain source, Domain target) Create a new mapping maintained by this authority between the specified domains (optional operation).
java.util.Set<Assignment>	getAssignments() Return the set of assignments maintained by this authority.
java.util.Set<Domain>	getDomains() Return the set of domains maintained by this authority.
java.util.Set<Mapping>	getMappings() Return the set of mappings between domains maintained by this authority.
java.lang.String	getName() Return the name of this authority.

Method Detail

getName

java.lang.String getName()

Return the name of this authority.

Returns:

the name

getDomains

java.util.Set<Domain> getDomains()

Return the set of domains maintained by this authority. The set must not be null, but may be empty.

Returns:

the set of domains

getMappings

java.util.Set<Mapping> getMappings()

Return the set of mappings between domains maintained by this authority. The set must not be null, but may be empty.

Returns:

the set of mappings

getAssignments

java.util.Set<Assignment> getAssignments()

Return the set of assignments maintained by this authority. The set must not be null, but may be empty.

Returns:

the set of assignments

createDomain

Domain createDomain(java.lang.String name)

Create a new domain maintained by this authority with the specified name (optional operation). The specified name must be unique within this authority and may not be null.

Parameters:

name - domain name

Returns:

new domain

Throws:

java.lang.UnsupportedOperationException - if the createDomain method is not supported by this Authority

createMapping

Mapping createMapping(Domain source,
                      Domain target)

Create a new mapping maintained by this authority between the specified domains (optional operation). The specified domains must not be null.

Parameters:

source - mapping source domain

target - mapping target domain

Returns:

new mapping

Throws:

java.lang.UnsupportedOperationException - if the createMapping method is not supported by this Authority

createAssignment

Assignment createAssignment(Concept concept,
                            Assignable assignable,
                            java.util.Set<Evidence> evidence)

Create a new assignment maintained by this authority of concept to assignable, supported by evidence (optional operation). The specified concept and assignable must not be null.

Parameters:

concept - assignment source concept

assignable - assignment target assignable

evidence - set of evidence

Returns:

new assignment

Throws:

java.lang.UnsupportedOperationException - if the createAssignment method is not supported by this Authority