org.dishevelled.vocabulary
Interface Mapping

All Known Implementing Classes:
SimpleMapping

public interface Mapping

A mapping is a binary directional link between a source and a target domain containing projections of concepts from the source domain to concepts in the target domain.

Version:
$Revision$ $Date$
Author:
Michael Heuer

Method Summary
 Projection createProjection(java.lang.String name, Concept source, Concept target, java.util.Set<Evidence> evidence)
          Create a new projection in this mapping between concepts source and target with the specified name (optional operation).
 Authority getAuthority()
          Return the authority for this mapping.
 java.util.Set<Projection> getProjections()
          Return the set of all projections in this mapping.
 Domain getSource()
          Return the source domain of this mapping.
 Domain getTarget()
          Return the target domain of this mapping.
 

Method Detail

getSource

Domain getSource()
Return the source domain of this mapping. The source domain must not be null.

Returns:
the source domain

getTarget

Domain getTarget()
Return the target domain of this mapping. The target domain must not be null.

Returns:
the target domain

getProjections

java.util.Set<Projection> getProjections()
Return the set of all projections in this mapping. The set must not be null, but may be empty.

Returns:
the set of all projections

getAuthority

Authority getAuthority()
Return the authority for this mapping. The authority must not be null.

Returns:
the authority

createProjection

Projection createProjection(java.lang.String name,
                            Concept source,
                            Concept target,
                            java.util.Set<Evidence> evidence)
Create a new projection in this mapping between concepts source and target with the specified name (optional operation). The source concept must be within the source domain of this mapping, and the target domain must be within the target domain of this mapping. Only one projection may exist between the same source and target with the same name within this mapping. The source and target concepts must not be null.

Parameters:
name - projection name
source - projection source concept
target - projection target concept
evidence - set of evidence
Returns:
new projection
Throws:
java.lang.UnsupportedOperationException - if the createProjection method is not supported by this Mapping


Copyright (c) 2002-2004 held jointly by the individual authors. Licensed under the GNU Lesser General Public License (LGPL).