Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.ceryle.tm
Class PSIUtils

java.lang.Object
  extended by org.ceryle.tm.PSIUtils

public class PSIUtils
extends Object

PSIUtils is a supplement to the TopicMapProcessor, providing a core set of PSI-based Topics upon demand.

The Topics and Locators are stored within instances of a TopicLocatorPool.

Since:
JDK1.3
Version:
$Id: PSIUtils.java,v 3.1 2007-06-15 12:09:32 altheim Exp $
Author:
Murray Altheim

Constructor Summary
PSIUtils(TopicMapProcessor tmprocessor)
           
 
Method Summary
 void checkSubject(Topic topic, Locator locator)
          Checks to see that topic contains the subject indicator locator.
 Set getFacetsOf(Topic topic, Topic type, Set set)
          Returns all Topics playing a role in 'hasFacet' associations with the Topic topic.
 Association getPredicateTemplate(TopicMap tm)
          Sets the Predicate template, necessary for use with assertions (and Ceryle-based visualization).
 Set getSubclasses(Topic topic)
          Returns a Set with the direct subclasses of Topic topic.
 Set getSuperclasses(Topic topic)
          Returns a Set with the direct superclasses of Topic topic.
 Set getTaxonomic(Topic topic, Set set, boolean superclass)
          Returns a List containing the superclasses of Topic topic, in the order of traversal (as much as is possible).
 Locator locClass(TopicMap topicmap)
          Returns a Locator using the XTM 1.0 "Class" PSI as its address/URI.
 Locator locClassInstance(TopicMap topicmap)
          Returns a reusable Locator using the XTM 1.0 "Class-Instance" PSI as its address/URI.
 Locator locComponent(TopicMap topicmap)
          Returns a Locator using the Ceryle "Component" PSI as its address/URI.
 Locator locDisplay(TopicMap topicmap)
          Returns a Locator using the XTM 1.0 "Display" PSI as its address/URI.
 Locator locFrom(TopicMap topicmap)
          Returns a Locator using the Ceryle "From" PSI as its address/URI.
 Locator locInstance(TopicMap topicmap)
          Returns a Locator using the XTM 1.0 "Instance" PSI as its address/URI.
 Locator locObject(TopicMap topicmap)
          Returns a Locator using the Ceryle ontology Topic "Object" PSI as its address/URI.
 Locator locPredicate(TopicMap topicmap)
          Returns a Locator using the Ceryle ontology Topic "Predicate" PSI as its address/URI.
 Locator locSort(TopicMap topicmap)
          Returns a Locator using the XTM 1.0 "Sort" PSI as its address/URI.
 Locator locSubclass(TopicMap topicmap)
          Returns a Locator using the XTM 1.0 "Subclass" PSI as its address/URI.
 Locator locSubject(TopicMap topicmap)
          Returns a Locator using the Ceryle ontology Topic "Subject" PSI as its address/URI.
 Locator locSuperclass(TopicMap topicmap)
          Returns a Locator using the XTM 1.0 "Superclass" PSI as its address/URI.
 Locator locSuperclassSubclass(TopicMap topicmap)
          Returns a Locator using the XTM 1.0 "Superclass-Subclass" PSI as its address/URI.
 Locator locTo(TopicMap topicmap)
          Returns a Locator using the Ceryle "To" PSI as its address/URI.
 Topic psiAbout(TopicMap topicmap)
          Returns a Topic using the Ceryle "About" * PSI as its subject indicator.
 Topic psiAssertion(TopicMap topicmap)
          Returns a Topic using the Ceryle ontology Topic "Assertion" PSI as its subject indicator.
 Topic psiAssociation(TopicMap topicmap)
          Returns a Topic using the XTM 1.0 "Association" PSI as its subject indicator.
 Topic psiBackgroundImage(TopicMap topicmap)
          Returns a Topic using the Ceryle (graph) Background Image PSI as its subject indicator.
 Topic psiBoolean(TopicMap topicmap)
          Returns a Topic using the XML Schema Datatypes Boolean PSI as its subject indicator.
 Topic psiClass(TopicMap topicmap)
          Returns a Topic using the XTM 1.0 "Class" PSI as its subject indicator.
 Topic psiClassInstance(TopicMap topicmap)
          Returns a Topic using the XTM 1.0 "Class-Instance" PSI as its subject indicator.
 Topic psiCLUT(TopicMap topicmap)
          Returns a Topic using the Ceryle Color Lookup Table (CLUT) PSI as its subject indicator.
 Topic psiComponent(TopicMap topicmap)
          Returns a Topic using the Ceryle "Component" PSI as its subject indicator.
 Topic psiConcept(TopicMap topicmap)
          Returns a Topic using the Ceryle authoring ontology Topic "Concept" PSI as its subject indicator.
 Topic psiContext(TopicMap topicmap)
          Returns a Topic using the Ceryle authoring ontology Topic "Context" PSI as its subject indicator.
 Topic psiDatatype(TopicMap topicmap)
          Returns a Topic using the XML Schema Datatypes Datatype PSI as its subject indicator.
 Topic psiDate(TopicMap topicmap)
          Returns a Topic using the XML Schema Datatypes Date PSI as its subject indicator.
 Topic psiDateTime(TopicMap topicmap)
          Returns a Topic using the XML Schema Datatypes DateTime PSI as its subject indicator.
 Topic psiDCMI(TopicMap topicmap, String name)
          Returns a Topic whose subject indicator is a DCMI URI, given the DCMI Element name name.
 Topic psiDescription(TopicMap topicmap)
          Returns a Topic using the Ceryle "Description" PSI as its subject indicator.
 Topic psiDisplay(TopicMap topicmap)
          Returns a Topic using the XTM 1.0 "Display" PSI as its subject indicator.
 Topic psiEnglish(TopicMap topicmap)
          Returns a Topic using the XTM "English" PSI as its subject indicator.
 Topic psiFacet(TopicMap topicmap)
          Returns a Topic using the Ceryle "facet" PSI as its subject indicator.
 Topic psiFacetDefault(TopicMap topicmap)
          Returns a Topic using the Ceryle "facetDefault" PSI as its subject indicator.
 Topic psiFaceted(TopicMap topicmap)
          Returns a Topic using the Ceryle "faceted" PSI as its subject indicator.
 Topic psiFacetMaxExcl(TopicMap topicmap)
          Returns a Topic using the Ceryle "facetMaxExcl" PSI as its subject indicator.
 Topic psiFacetMaxIncl(TopicMap topicmap)
          Returns a Topic using the Ceryle "facetMaxIncl" PSI as its subject indicator.
 Topic psiFacetMinExcl(TopicMap topicmap)
          Returns a Topic using the Ceryle "facetMinExcl" PSI as its subject indicator.
 Topic psiFacetMinIncl(TopicMap topicmap)
          Returns a Topic using the Ceryle "facetMinIncl" PSI as its subject indicator.
 Topic psiFacetName(TopicMap topicmap)
          Returns a Topic using the Ceryle "facetName" PSI as its subject indicator.
 Topic psiFacets(TopicMap topicmap)
          Returns a Topic using the Ceryle "facets" PSI as its subject indicator.
 Topic psiFacetType(TopicMap topicmap)
          Returns a Topic using the Ceryle "facetType" PSI as its subject indicator.
 Topic psiFacetValue(TopicMap topicmap)
          Returns a Topic using the Ceryle "facetValue" PSI as its subject indicator.
 Topic psiFavoriteTopics(TopicMap topicmap)
          Returns a Topic using the Ceryle "Favorite Topics" PSI as its subject indicator.
 Topic psiFrom(TopicMap topicmap)
          Returns a Topic using the Ceryle "from" PSI as its subject indicator, one of the roles in an OrderRelation.
 Topic psiGenericRelation(TopicMap topicmap)
          Returns a Topic using the Ceryle ontology Topic "Generic Relation" PSI as its subject indicator.
 Topic psiGraphSettings(TopicMap topicmap)
          Returns a Topic using the Ceryle Graph Settings PSI as its subject indicator.
 Topic psiHasFacet(TopicMap topicmap)
          Returns a Topic using the Ceryle "hasFacet" PSI as its subject indicator.
 Topic psiHidden(TopicMap topicmap)
          Returns a Topic using the Ceryle "Hidden" PSI as its subject indicator.
 Topic psiInstance(TopicMap topicmap)
          Returns a Topic using the XTM 1.0 "Instance" PSI as its subject indicator.
 Topic psiLoadResource(TopicMap topicmap)
          Returns a Topic using the Ceryle's XTM 1.0 "Load Resource" PSI as its subject indicator.
 Topic psiNodeColor(TopicMap topicmap)
          Returns a Topic using the Ceryle "Node Color" PSI as its subject indicator.
 Topic psiNodeLocation(TopicMap topicmap)
          Returns a Topic using the Ceryle "Node Location" PSI as its subject indicator.
 Topic psiObject(TopicMap topicmap)
          Returns a Topic using the Ceryle ontology Topic "Object" PSI as its subject indicator.
 Topic psiOccurrence(TopicMap topicmap)
          Returns a Topic using the XTM 1.0 "Occurrence" PSI as its subject indicator.
 Topic psiOrderRelation(TopicMap topicmap)
          Returns a Topic using the Ceryle ontology Topic "OrderRelation" PSI as its subject indicator.
 Topic psiPart(TopicMap topicmap)
          Returns a Topic using the Ceryle authoring ontology Topic "Part" PSI as its subject indicator.
 Topic psiPartOf(TopicMap topicmap)
          Returns a Topic using the Ceryle authoring ontology Topic "PartOf" PSI as its subject indicator.
 Topic psiPredicate(TopicMap topicmap)
          Returns a Topic using the Ceryle ontology Topic "Predicate" PSI as its subject indicator.
 Topic psiProtected(TopicMap topicmap)
          Returns a Topic using the Ceryle "Protected" PSI as its subject indicator.
 Topic psiRelation(TopicMap topicmap)
          Returns a Topic using the Ceryle ontology Topic "Relation" PSI as its subject indicator.
 Topic psiSelected(TopicMap topicmap)
          Returns a Topic using the Ceryle "Selected" PSI as its subject indicator.
 Topic psiSequence(TopicMap topicmap)
          Returns a Topic using the Ceryle "Sequence" PSI as its subject indicator.
 Topic psiSort(TopicMap topicmap)
          Returns a Topic using the XTM 1.0 "Sort" PSI as its subject indicator.
 Topic psiString(TopicMap topicmap)
          Returns a Topic using the XML Schema Datatypes String PSI as its subject indicator.
 Topic psiStringEnumeration(TopicMap topicmap)
          Returns a Topic using the XML Schema Datatypes String Enumeration PSI as its subject indicator.
 Topic psiSubclass(TopicMap topicmap)
          Returns a Topic using the XTM 1.0 "Subclass" PSI as its subject indicator.
 Topic psiSubject(TopicMap topicmap)
          Returns a Topic using the Ceryle ontology Topic "Subject" PSI as its subject indicator.
 Topic psiSuperclass(TopicMap topicmap)
          Returns a Topic using the XTM 1.0 "Superclass" PSI as its subject indicator.
 Topic psiSuperclassSubclass(TopicMap topicmap)
          Returns a Topic using the XTM 1.0 "Superclass-Subclass" PSI as its subject indicator.
 Topic psiTemplate(TopicMap topicmap)
          Returns a Topic using the Ceryle "Template" PSI as its subject indicator.
 Topic psiThing(TopicMap topicmap)
          Returns a Topic using the Ceryle authoring ontology Topic "Thing" PSI as its subject indicator.
 Topic psiTo(TopicMap topicmap)
          Returns a Topic using the Ceryle "to" PSI as its subject indicator, one of the roles in an OrderRelation.
 Topic psiTopic(TopicMap topicmap)
          Returns a Topic using the XTM 1.0 "Topic" PSI as its subject indicator.
 Topic psiTruthFunction(TopicMap topicmap)
          Returns a Topic using the Ceryle ontology Topic "TruthFunction" PSI as its subject indicator.
 Topic psiVisible(TopicMap topicmap)
          Returns a Topic using the Ceryle "Visible" PSI as its subject indicator.
 Topic psiWhole(TopicMap topicmap)
          Returns a Topic using the Ceryle authoring ontology Topic "Whole" PSI as its subject indicator.
 Topic returnPredicate(TopicMap topicmap)
          Returns the Predicate (generic relation) Topic if it already exists.
 Topic[] scopeEnglish(TopicMap topicmap)
          Returns a Scope (an array of Topics) whose theme is the XTM "English" PSI.
 Topic[] scopeFacet(TopicMap topicmap)
          Returns a Scope (an array of Topics) whose theme is the Ceryle "facet" PSI.
 Topic[] scopeTemplate(TopicMap topicmap)
          Returns a Scope (an array of Topics) whose theme is the Ceryle "template" PSI.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

PSIUtils

public PSIUtils(TopicMapProcessor tmprocessor)
Method Detail

psiTopic

public Topic psiTopic(TopicMap topicmap)
               throws TopicMapException
Returns a Topic using the XTM 1.0 "Topic" PSI as its subject indicator. This is a convenience method.

Throws:
TopicMapException

psiAssociation

public Topic psiAssociation(TopicMap topicmap)
                     throws TopicMapException
Returns a Topic using the XTM 1.0 "Association" PSI as its subject indicator. This is a convenience method.

Throws:
TopicMapException

psiOccurrence

public Topic psiOccurrence(TopicMap topicmap)
                    throws TopicMapException
Returns a Topic using the XTM 1.0 "Occurrence" PSI as its subject indicator. This is a convenience method.

Throws:
TopicMapException

checkSubject

public void checkSubject(Topic topic,
                         Locator locator)
                  throws TopicMapException
Checks to see that topic contains the subject indicator locator. If not, it is added.

Throws:
TopicMapException

psiClassInstance

public Topic psiClassInstance(TopicMap topicmap)
                       throws TopicMapException
Returns a Topic using the XTM 1.0 "Class-Instance" PSI as its subject indicator. This is a convenience method.

Throws:
TopicMapException

locClassInstance

public Locator locClassInstance(TopicMap topicmap)
                         throws TopicMapException
Returns a reusable Locator using the XTM 1.0 "Class-Instance" PSI as its address/URI. This is a convenience method.

Throws:
TopicMapException

psiClass

public Topic psiClass(TopicMap topicmap)
               throws TopicMapException
Returns a Topic using the XTM 1.0 "Class" PSI as its subject indicator. This is a convenience method.

Throws:
TopicMapException

locClass

public Locator locClass(TopicMap topicmap)
                 throws TopicMapException
Returns a Locator using the XTM 1.0 "Class" PSI as its address/URI. This is a convenience method.

Throws:
TopicMapException

psiInstance

public Topic psiInstance(TopicMap topicmap)
                  throws TopicMapException
Returns a Topic using the XTM 1.0 "Instance" PSI as its subject indicator. This is a convenience method.

Throws:
TopicMapException

locInstance

public Locator locInstance(TopicMap topicmap)
                    throws TopicMapException
Returns a Locator using the XTM 1.0 "Instance" PSI as its address/URI. This is a convenience method.

Throws:
TopicMapException

psiSuperclassSubclass

public Topic psiSuperclassSubclass(TopicMap topicmap)
                            throws TopicMapException
Returns a Topic using the XTM 1.0 "Superclass-Subclass" PSI as its subject indicator. This is a convenience method.

Throws:
TopicMapException

locSuperclassSubclass

public Locator locSuperclassSubclass(TopicMap topicmap)
                              throws TopicMapException
Returns a Locator using the XTM 1.0 "Superclass-Subclass" PSI as its address/URI. This is a convenience method.

Throws:
TopicMapException

psiSuperclass

public Topic psiSuperclass(TopicMap topicmap)
                    throws TopicMapException
Returns a Topic using the XTM 1.0 "Superclass" PSI as its subject indicator. This is a convenience method.

Throws:
TopicMapException

locSuperclass

public Locator locSuperclass(TopicMap topicmap)
                      throws TopicMapException
Returns a Locator using the XTM 1.0 "Superclass" PSI as its address/URI. This is a convenience method.

Throws:
TopicMapException

psiSubclass

public Topic psiSubclass(TopicMap topicmap)
                  throws TopicMapException
Returns a Topic using the XTM 1.0 "Subclass" PSI as its subject indicator. This is a convenience method.

Throws:
TopicMapException

locSubclass

public Locator locSubclass(TopicMap topicmap)
                    throws TopicMapException
Returns a Locator using the XTM 1.0 "Subclass" PSI as its address/URI. This is a convenience method.

Throws:
TopicMapException

locTo

public Locator locTo(TopicMap topicmap)
              throws TopicMapException
Returns a Locator using the Ceryle "To" PSI as its address/URI. This is a convenience method.

Throws:
TopicMapException

locFrom

public Locator locFrom(TopicMap topicmap)
                throws TopicMapException
Returns a Locator using the Ceryle "From" PSI as its address/URI. This is a convenience method.

Throws:
TopicMapException

psiSort

public Topic psiSort(TopicMap topicmap)
              throws TopicMapException
Returns a Topic using the XTM 1.0 "Sort" PSI as its subject indicator. This is a convenience method.

Throws:
TopicMapException

locSort

public Locator locSort(TopicMap topicmap)
                throws TopicMapException
Returns a Locator using the XTM 1.0 "Sort" PSI as its address/URI. This is a convenience method.

Throws:
TopicMapException

psiDisplay

public Topic psiDisplay(TopicMap topicmap)
                 throws TopicMapException
Returns a Topic using the XTM 1.0 "Display" PSI as its subject indicator. This is a convenience method.

Throws:
TopicMapException

locDisplay

public Locator locDisplay(TopicMap topicmap)
                   throws TopicMapException
Returns a Locator using the XTM 1.0 "Display" PSI as its address/URI. This is a convenience method.

Throws:
TopicMapException

psiFacets

public Topic psiFacets(TopicMap topicmap)
                throws TopicMapException
Returns a Topic using the Ceryle "facets" PSI as its subject indicator. This is a convenience method.

Throws:
TopicMapException

psiHasFacet

public Topic psiHasFacet(TopicMap topicmap)
                  throws TopicMapException
Returns a Topic using the Ceryle "hasFacet" PSI as its subject indicator. This is a convenience method.

Throws:
TopicMapException

psiFacet

public Topic psiFacet(TopicMap topicmap)
               throws TopicMapException
Returns a Topic using the Ceryle "facet" PSI as its subject indicator. This is a convenience method.

Throws:
TopicMapException

scopeFacet

public Topic[] scopeFacet(TopicMap topicmap)
                   throws TopicMapException
Returns a Scope (an array of Topics) whose theme is the Ceryle "facet" PSI. This is a convenience method.

Throws:
TopicMapException

psiFaceted

public Topic psiFaceted(TopicMap topicmap)
                 throws TopicMapException
Returns a Topic using the Ceryle "faceted" PSI as its subject indicator. This is a convenience method.

Throws:
TopicMapException

psiFacetName

public Topic psiFacetName(TopicMap topicmap)
                   throws TopicMapException
Returns a Topic using the Ceryle "facetName" PSI as its subject indicator. This is a convenience method.

Throws:
TopicMapException

psiFacetType

public Topic psiFacetType(TopicMap topicmap)
                   throws TopicMapException
Returns a Topic using the Ceryle "facetType" PSI as its subject indicator. This is a convenience method.

Throws:
TopicMapException

psiFacetValue

public Topic psiFacetValue(TopicMap topicmap)
                    throws TopicMapException
Returns a Topic using the Ceryle "facetValue" PSI as its subject indicator. This is a convenience method.

Throws:
TopicMapException

psiFacetDefault

public Topic psiFacetDefault(TopicMap topicmap)
                      throws TopicMapException
Returns a Topic using the Ceryle "facetDefault" PSI as its subject indicator. This is a convenience method.

Throws:
TopicMapException

psiFacetMinIncl

public Topic psiFacetMinIncl(TopicMap topicmap)
                      throws TopicMapException
Returns a Topic using the Ceryle "facetMinIncl" PSI as its subject indicator. This is a convenience method.

Throws:
TopicMapException

psiFacetMaxIncl

public Topic psiFacetMaxIncl(TopicMap topicmap)
                      throws TopicMapException
Returns a Topic using the Ceryle "facetMaxIncl" PSI as its subject indicator. This is a convenience method.

Throws:
TopicMapException

psiFacetMinExcl

public Topic psiFacetMinExcl(TopicMap topicmap)
                      throws TopicMapException
Returns a Topic using the Ceryle "facetMinExcl" PSI as its subject indicator. This is a convenience method.

Throws:
TopicMapException

psiFacetMaxExcl

public Topic psiFacetMaxExcl(TopicMap topicmap)
                      throws TopicMapException
Returns a Topic using the Ceryle "facetMaxExcl" PSI as its subject indicator. This is a convenience method.

Throws:
TopicMapException

getFacetsOf

public Set getFacetsOf(Topic topic,
                       Topic type,
                       Set set)
                throws TopicMapException
Returns all Topics playing a role in 'hasFacet' associations with the Topic topic. If the optional Topic type is included, this acts as an additional filter, returning only facets matching that type. If the optional set is supplied, it will be used as the returned container (and cleared of any existing contents), otherwise a new Set will be created. Returns an empty Set (rather than null) if there is no match.

Throws:
TopicMapException

getSuperclasses

public Set getSuperclasses(Topic topic)
                    throws TopicMapException
Returns a Set with the direct superclasses of Topic topic. This is a convenience method that calls TopicMapProcessor.getPlayersOfRoleInTypedAssociation(Topic,Topic,Topic,Topic,Set) with an appropriate association type and roles.

Throws:
TopicMapException

getSubclasses

public Set getSubclasses(Topic topic)
                  throws TopicMapException
Returns a Set with the direct subclasses of Topic topic. This is a convenience method that calls TopicMapProcessor.getPlayersOfRoleInTypedAssociation(Topic,Topic,Topic,Topic,Set) with an appropriate association type and roles.

Throws:
TopicMapException

getTaxonomic

public Set getTaxonomic(Topic topic,
                        Set set,
                        boolean superclass)
                 throws TopicMapException
Returns a List containing the superclasses of Topic topic, in the order of traversal (as much as is possible). If the Topic has no superclasses, returns null. If the boolean is true, superclasses are queried; if false, subclasses. This recurses to the limit of a superclass traversal. The returned value is backed by a SetModel, so the results can be used directly in a GUI list (JComboBox, etc.).

Throws:
TopicMapException

psiThing

public Topic psiThing(TopicMap topicmap)
               throws TopicMapException
Returns a Topic using the Ceryle authoring ontology Topic "Thing" PSI as its subject indicator. This is a convenience method.

Throws:
TopicMapException

psiConcept

public Topic psiConcept(TopicMap topicmap)
                 throws TopicMapException
Returns a Topic using the Ceryle authoring ontology Topic "Concept" PSI as its subject indicator. This is a convenience method.

Throws:
TopicMapException

returnPredicate

public Topic returnPredicate(TopicMap topicmap)
                      throws TopicMapException
Returns the Predicate (generic relation) Topic if it already exists. This is labeled differently than the psi* methods because it creates the entire superclass tree. The first time this method is called, the ontological subtree from Thing to Predicate is created so that Predicate is not an orphan.

This creates the equivalent of the LTM: 

   [Thing = "Thing"
     ("http://purl.org/ceryle/psi/ceryle/#Thing"]
   [Concept ; Thing = "Concept"
     ("http://purl.org/ceryle/psi/ceryle/#Concept"]
   [Relation ; Concept = "Relation"
     ("http://purl.org/ceryle/psi/ceryle/#Relation"]
   [TruthFunction ; Relation = "Truth Function"
     ("http://purl.org/ceryle/psi/ceryle/#TruthFunction"]
   [Predicate ; TruthFunction = "Predicate"
     ("http://purl.org/ceryle/psi/ceryle/#Predicate"]

Throws:
TopicMapException

psiRelation

public Topic psiRelation(TopicMap topicmap)
                  throws TopicMapException
Returns a Topic using the Ceryle ontology Topic "Relation" PSI as its subject indicator. This is a convenience method.

Throws:
TopicMapException

psiTruthFunction

public Topic psiTruthFunction(TopicMap topicmap)
                       throws TopicMapException
Returns a Topic using the Ceryle ontology Topic "TruthFunction" PSI as its subject indicator. This is a convenience method.

Throws:
TopicMapException

psiGenericRelation

public Topic psiGenericRelation(TopicMap topicmap)
                         throws TopicMapException
Returns a Topic using the Ceryle ontology Topic "Generic Relation" PSI as its subject indicator. This is a convenience method.

Throws:
TopicMapException

psiAssertion

public Topic psiAssertion(TopicMap topicmap)
                   throws TopicMapException
Returns a Topic using the Ceryle ontology Topic "Assertion" PSI as its subject indicator. This is a convenience method.

Throws:
TopicMapException

psiPredicate

public Topic psiPredicate(TopicMap topicmap)
                   throws TopicMapException
Returns a Topic using the Ceryle ontology Topic "Predicate" PSI as its subject indicator. This is a convenience method.

Throws:
TopicMapException

locPredicate

public Locator locPredicate(TopicMap topicmap)
                     throws TopicMapException
Returns a Locator using the Ceryle ontology Topic "Predicate" PSI as its address/URI. This is a convenience method.

Throws:
TopicMapException

psiSubject

public Topic psiSubject(TopicMap topicmap)
                 throws TopicMapException
Returns a Topic using the Ceryle ontology Topic "Subject" PSI as its subject indicator. This is a convenience method.

Throws:
TopicMapException

locSubject

public Locator locSubject(TopicMap topicmap)
                   throws TopicMapException
Returns a Locator using the Ceryle ontology Topic "Subject" PSI as its address/URI. This is a convenience method.

Throws:
TopicMapException

psiObject

public Topic psiObject(TopicMap topicmap)
                throws TopicMapException
Returns a Topic using the Ceryle ontology Topic "Object" PSI as its subject indicator. This is a convenience method.

Throws:
TopicMapException

locObject

public Locator locObject(TopicMap topicmap)
                  throws TopicMapException
Returns a Locator using the Ceryle ontology Topic "Object" PSI as its address/URI. This is a convenience method.

Throws:
TopicMapException

getPredicateTemplate

public Association getPredicateTemplate(TopicMap tm)
                                 throws TopicMapException
Sets the Predicate template, necessary for use with assertions (and Ceryle-based visualization). This is a convenience method.

This creates an Association whose type is the Predicate PSI in the scope of the Template PSI, sets the From PSI as the role on the Subject PSI player, and the To PSI as the role on the Object PSI player.

Throws:
TopicMapException

psiOrderRelation

public Topic psiOrderRelation(TopicMap topicmap)
                       throws TopicMapException
Returns a Topic using the Ceryle ontology Topic "OrderRelation" PSI as its subject indicator. This is a convenience method.

Throws:
TopicMapException

psiContext

public Topic psiContext(TopicMap topicmap)
                 throws TopicMapException
Returns a Topic using the Ceryle authoring ontology Topic "Context" PSI as its subject indicator. This is a convenience method.

Throws:
TopicMapException

psiPart

public Topic psiPart(TopicMap topicmap)
              throws TopicMapException
Returns a Topic using the Ceryle authoring ontology Topic "Part" PSI as its subject indicator. This is a convenience method.

Throws:
TopicMapException

psiWhole

public Topic psiWhole(TopicMap topicmap)
               throws TopicMapException
Returns a Topic using the Ceryle authoring ontology Topic "Whole" PSI as its subject indicator. This is a convenience method.

Throws:
TopicMapException

psiPartOf

public Topic psiPartOf(TopicMap topicmap)
                throws TopicMapException
Returns a Topic using the Ceryle authoring ontology Topic "PartOf" PSI as its subject indicator. This is a convenience method.

Throws:
TopicMapException

psiComponent

public Topic psiComponent(TopicMap topicmap)
                   throws TopicMapException
Returns a Topic using the Ceryle "Component" PSI as its subject indicator. This is a convenience method.

Throws:
TopicMapException

locComponent

public Locator locComponent(TopicMap topicmap)
                     throws TopicMapException
Returns a Locator using the Ceryle "Component" PSI as its address/URI. This is a convenience method.

Throws:
TopicMapException

psiDescription

public Topic psiDescription(TopicMap topicmap)
                     throws TopicMapException
Returns a Topic using the Ceryle "Description" PSI as its subject indicator. This is a convenience method.

Throws:
TopicMapException

psiHidden

public Topic psiHidden(TopicMap topicmap)
                throws TopicMapException
Returns a Topic using the Ceryle "Hidden" PSI as its subject indicator. This is a convenience method.

Throws:
TopicMapException

psiVisible

public Topic psiVisible(TopicMap topicmap)
                 throws TopicMapException
Returns a Topic using the Ceryle "Visible" PSI as its subject indicator. This is a convenience method.

Throws:
TopicMapException

psiAbout

public Topic psiAbout(TopicMap topicmap)
               throws TopicMapException
Returns a Topic using the Ceryle "About" * PSI as its subject indicator. This is a convenience method.

Throws:
TopicMapException

psiTemplate

public Topic psiTemplate(TopicMap topicmap)
                  throws TopicMapException
Returns a Topic using the Ceryle "Template" PSI as its subject indicator. This is a convenience method.

Throws:
TopicMapException

psiProtected

public Topic psiProtected(TopicMap topicmap)
                   throws TopicMapException
Returns a Topic using the Ceryle "Protected" PSI as its subject indicator. This is a convenience method.

Throws:
TopicMapException

scopeTemplate

public Topic[] scopeTemplate(TopicMap topicmap)
                      throws TopicMapException
Returns a Scope (an array of Topics) whose theme is the Ceryle "template" PSI. This is a convenience method.

Throws:
TopicMapException

psiLoadResource

public Topic psiLoadResource(TopicMap topicmap)
                      throws TopicMapException
Returns a Topic using the Ceryle's XTM 1.0 "Load Resource" PSI as its subject indicator. This is a convenience method.

Throws:
TopicMapException

psiSequence

public Topic psiSequence(TopicMap topicmap)
                  throws TopicMapException
Returns a Topic using the Ceryle "Sequence" PSI as its subject indicator. This is a convenience method.

Throws:
TopicMapException

psiFrom

public Topic psiFrom(TopicMap topicmap)
              throws TopicMapException
Returns a Topic using the Ceryle "from" PSI as its subject indicator, one of the roles in an OrderRelation. This is a convenience method.

Throws:
TopicMapException

psiTo

public Topic psiTo(TopicMap topicmap)
            throws TopicMapException
Returns a Topic using the Ceryle "to" PSI as its subject indicator, one of the roles in an OrderRelation. This is a convenience method.

Throws:
TopicMapException

psiDCMI

public Topic psiDCMI(TopicMap topicmap,
                     String name)
              throws TopicMapException
Returns a Topic whose subject indicator is a DCMI URI, given the DCMI Element name name. This is a convenience method.

Throws:
TopicMapException
See Also:
DCMI

psiCLUT

public Topic psiCLUT(TopicMap topicmap)
              throws TopicMapException
Returns a Topic using the Ceryle Color Lookup Table (CLUT) PSI as its subject indicator. This is a convenience method.

Throws:
TopicMapException

psiBackgroundImage

public Topic psiBackgroundImage(TopicMap topicmap)
                         throws TopicMapException
Returns a Topic using the Ceryle (graph) Background Image PSI as its subject indicator. This is a convenience method.

Throws:
TopicMapException

psiGraphSettings

public Topic psiGraphSettings(TopicMap topicmap)
                       throws TopicMapException
Returns a Topic using the Ceryle Graph Settings PSI as its subject indicator. This is a convenience method.

Throws:
TopicMapException

psiNodeColor

public Topic psiNodeColor(TopicMap topicmap)
                   throws TopicMapException
Returns a Topic using the Ceryle "Node Color" PSI as its subject indicator. This is a convenience method.

Throws:
TopicMapException

psiNodeLocation

public Topic psiNodeLocation(TopicMap topicmap)
                      throws TopicMapException
Returns a Topic using the Ceryle "Node Location" PSI as its subject indicator. This is a convenience method.

Throws:
TopicMapException

psiFavoriteTopics

public Topic psiFavoriteTopics(TopicMap topicmap)
                        throws TopicMapException
Returns a Topic using the Ceryle "Favorite Topics" PSI as its subject indicator. This is a convenience method.

Throws:
TopicMapException

psiSelected

public Topic psiSelected(TopicMap topicmap)
                  throws TopicMapException
Returns a Topic using the Ceryle "Selected" PSI as its subject indicator. This is a convenience method.

Throws:
TopicMapException

psiEnglish

public Topic psiEnglish(TopicMap topicmap)
                 throws TopicMapException
Returns a Topic using the XTM "English" PSI as its subject indicator. This is a convenience method.

Throws:
TopicMapException

scopeEnglish

public Topic[] scopeEnglish(TopicMap topicmap)
                     throws TopicMapException
Returns a Scope (an array of Topics) whose theme is the XTM "English" PSI. This is a convenience method.

Throws:
TopicMapException

psiDatatype

public Topic psiDatatype(TopicMap topicmap)
                  throws TopicMapException
Returns a Topic using the XML Schema Datatypes Datatype PSI as its subject indicator. This is a convenience method.

Throws:
TopicMapException

psiString

public Topic psiString(TopicMap topicmap)
                throws TopicMapException
Returns a Topic using the XML Schema Datatypes String PSI as its subject indicator. This is a convenience method.

Throws:
TopicMapException

psiStringEnumeration

public Topic psiStringEnumeration(TopicMap topicmap)
                           throws TopicMapException
Returns a Topic using the XML Schema Datatypes String Enumeration PSI as its subject indicator. This is a convenience method.

Throws:
TopicMapException

psiBoolean

public Topic psiBoolean(TopicMap topicmap)
                 throws TopicMapException
Returns a Topic using the XML Schema Datatypes Boolean PSI as its subject indicator. This is a convenience method.

Throws:
TopicMapException

psiDate

public Topic psiDate(TopicMap topicmap)
              throws TopicMapException
Returns a Topic using the XML Schema Datatypes Date PSI as its subject indicator. This is a convenience method.

Throws:
TopicMapException

psiDateTime

public Topic psiDateTime(TopicMap topicmap)
                  throws TopicMapException
Returns a Topic using the XML Schema Datatypes DateTime PSI as its subject indicator. This is a convenience method.

Throws:
TopicMapException
Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
The Ceryle Project. Copyright ©2001-2007 Murray Altheim, All Rights Reserved. See LICENSE included with distribution.