org.activemath.abstractcontent
Class MBaseRef.Dependency

java.lang.Object
  extended by org.activemath.abstractcontent.MBaseRef.Dependency
All Implemented Interfaces:
MBaseRef.Relation
Enclosing interface:
MBaseRef

public static class MBaseRef.Dependency
extends Object
implements MBaseRef.Relation

A useful class to describe a relation between two items as returned by MBaseRef.getDependencies(org.activemath.abstractcontent.MBaseID) and MBaseRef.getRelated(org.activemath.abstractcontent.MBaseID, java.util.Collection).

MBase implementations compute the relation-types according to rules described with each types here. Moreover, it is possible to encode, in OMDoc a relation element, child of extradata whose attribute type will be returned, as is, in this object, as getDependencyTypeString().


Field Summary
static int ABSTRACTLY_DEPENDS_ON
          This relation just mentions a dependency included by the author.
static int ASSERTION_IN_ASSERTION
          States that the on element is "used" or "quoted" in the content of the "of" element.
static int ASSERTION_IN_DEFINITION
          States that the on element is "used" or "quoted" in the content of the "of" element.
static int ASSERTION_IN_EXAMPLE
          States that the on element is "used" or "quoted" in the content of the "of" element.
static int ASSERTION_IN_EXERCISE
          States that the on element is "used" or "quoted" in the content of the "of" element.
static int ASSERTION_IN_METHOD
          States that the on element is "used" or "quoted" in the content of the "of" element.
static int ASSERTION_IN_OMTEXT
          States that the on element is "used" or "quoted" in the content of the "of" element.
static int ASSERTION_IN_PPMETHOD
          States that the on element is "used" or "quoted" in the content of the "of" element.
static int ASSERTION_IN_PROOF
          States that the on element is "used" or "quoted" in the content of the "of" element.
static int COMMENTS
          The forWhat of an OMtext: only the type of OMText, the of of the dependency is known.
static int DEFINES
          This relation is from a definition to a symbol to define a symbol.
static int DEFINITION_IN_ASSERTION
          States that the on element is "used" or "quoted" in the content of the "of" element.
static int DEFINITION_IN_DEFINITION
          States that the on element is "used" or "quoted" in the content of the "of" element.
static int DEFINITION_IN_EXAMPLE
          States that the on element is "used" or "quoted" in the content of the "of" element.
static int DEFINITION_IN_EXERCISE
          States that the on element is "used" or "quoted" in the content of the "of" element.
static int DEFINITION_IN_METHOD
          States that the on element is "used" or "quoted" in the content of the "of" element.
static int DEFINITION_IN_OMTEXT
          States that the on element is "used" or "quoted" in the content of the "of" element.
static int DEFINITION_IN_PPMETHOD
          States that the on element is "used" or "quoted" in the content of the "of" element.
static int DEFINITION_IN_PROOF
          States that the on element is "used" or "quoted" in the content of the "of" element.
static int EXAMPLE_IN_ASSERTION
          States that the on element is "used" or "quoted" in the content of the "of" element.
static int EXAMPLE_IN_DEFINITION
          States that the on element is "used" or "quoted" in the content of the "of" element.
static int EXAMPLE_IN_EXAMPLE
          States that the on element is "used" or "quoted" in the content of the "of" element.
static int EXAMPLE_IN_EXERCISE
          States that the on element is "used" or "quoted" in the content of the "of" element.
static int EXAMPLE_IN_METHOD
          States that the on element is "used" or "quoted" in the content of the "of" element.
static int EXAMPLE_IN_OMTEXT
          States that the on element is "used" or "quoted" in the content of the "of" element.
static int EXAMPLE_IN_PPMETHOD
          States that the on element is "used" or "quoted" in the content of the "of" element.
static int EXAMPLE_IN_PROOF
          States that the on element is "used" or "quoted" in the content of the "of" element.
static int EXERCISE_IN_ASSERTION
          States that the on element is "used" or "quoted" in the content of the "of" element.
static int EXERCISE_IN_DEFINITION
          States that the on element is "used" or "quoted" in the content of the "of" element.
static int EXERCISE_IN_EXAMPLE
          States that the on element is "used" or "quoted" in the content of the "of" element.
static int EXERCISE_IN_EXERCISE
          States that the on element is "used" or "quoted" in the content of the "of" element.
static int EXERCISE_IN_METHOD
          States that the on element is "used" or "quoted" in the content of the "of" element.
static int EXERCISE_IN_OMTEXT
          States that the on element is "used" or "quoted" in the content of the "of" element.
static int EXERCISE_IN_PPMETHOD
          States that the on element is "used" or "quoted" in the content of the "of" element.
static int EXERCISE_IN_PROOF
          States that the on element is "used" or "quoted" in the content of the "of" element.
static int EXERCISES
          The forWhat of an exercise.
 List forRelationNames
           
 MBaseID idOf
           
 MBaseID idOn
           
static int ILLUSTRATES
          The forWhat of an Example
static int IS_SUCH_FOR
          Defines the so-called forWhat type.
static int JUSTIFY_MULTIPLE_DEFINITIONS
          This relation proves why these definitions define the same symbol The definition is of the symbol on the assertion to prove the equivalence of all definitions.
static int METHOD_IN_ASSERTION
          States that the on element is "used" or "quoted" in the content of the "of" element.
static int METHOD_IN_DEFINITION
          States that the on element is "used" or "quoted" in the content of the "of" element.
static int METHOD_IN_EXAMPLE
          States that the on element is "used" or "quoted" in the content of the "of" element.
static int METHOD_IN_EXERCISE
          States that the on element is "used" or "quoted" in the content of the "of" element.
static int METHOD_IN_METHOD
          States that the on element is "used" or "quoted" in the content of the "of" element.
static int METHOD_IN_OMTEXT
          States that the on element is "used" or "quoted" in the content of the "of" element.
static int METHOD_IN_PROOF
          States that the on element is "used" or "quoted" in the content of the "of" element.
static int OMTEXT_IN_ASSERTION
          States that the on element is "used" or "quoted" in the content of the "of" element.
static int OMTEXT_IN_DEFINITION
          States that the on element is "used" or "quoted" in the content of the "of" element.
static int OMTEXT_IN_EXAMPLE
          States that the on element is "used" or "quoted" in the content of the "of" element.
static int OMTEXT_IN_EXERCISE
          States that the on element is "used" or "quoted" in the content of the "of" element.
static int OMTEXT_IN_METHOD
          States that the on element is "used" or "quoted" in the content of the "of" element.
static int OMTEXT_IN_OMTEXT
          States that the on element is "used" or "quoted" in the content of the "of" element.
static int OMTEXT_IN_PPMETHOD
          States that the on element is "used" or "quoted" in the content of the "of" element.
static int OMTEXT_IN_PROOF
          States that the on element is "used" or "quoted" in the content of the "of" element.
static int PPMETHOD_IN_ASSERTION
          States that the on element is "used" or "quoted" in the content of the "of" element.
static int PPMETHOD_IN_DEFINITION
          States that the on element is "used" or "quoted" in the content of the "of" element.
static int PPMETHOD_IN_EXAMPLE
          States that the on element is "used" or "quoted" in the content of the "of" element.
static int PPMETHOD_IN_EXERCISE
          States that the on element is "used" or "quoted" in the content of the "of" element.
static int PPMETHOD_IN_METHOD
          States that the on element is "used" or "quoted" in the content of the "of" element.
static int PPMETHOD_IN_OMTEXT
          States that the on element is "used" or "quoted" in the content of the "of" element.
static int PPMETHOD_IN_PROOF
          States that the on element is "used" or "quoted" in the content of the "of" element.
static int PROOF_IN_ASSERTION
          States that the on element is "used" or "quoted" in the content of the "of" element.
static int PROOF_IN_DEFINITION
          States that the on element is "used" or "quoted" in the content of the "of" element.
static int PROOF_IN_EXAMPLE
          States that the on element is "used" or "quoted" in the content of the "of" element.
static int PROOF_IN_EXERCISE
          States that the on element is "used" or "quoted" in the content of the "of" element.
static int PROOF_IN_METHOD
          States that the on element is "used" or "quoted" in the content of the "of" element.
static int PROOF_IN_OMTEXT
          States that the on element is "used" or "quoted" in the content of the "of" element.
static int PROOF_IN_PPMETHOD
          States that the on element is "used" or "quoted" in the content of the "of" element.
static int PROOF_IN_PROOF
          States that the on element is "used" or "quoted" in the content of the "of" element.
static int PROVES
          This relation is from a proof to an assertion Standardly neeeded by OMdoc specs.
static int SYMBOL_IN_ASSERTION
          States that the on element is "used" or "quoted" in the content of the "of" element.
static int SYMBOL_IN_DEFINITION
          States that the on element is "used" or "quoted" in the content of the "of" element.
static int SYMBOL_IN_EXAMPLE
          States that the on element is "used" or "quoted" in the content of the "of" element.
static int SYMBOL_IN_EXERCISE
          States that the on element is "used" or "quoted" in the content of the "of" element.
static int SYMBOL_IN_METHOD
          States that the on element is "used" or "quoted" in the content of the "of" element.
static int SYMBOL_IN_OMTEXT
          States that the on element is "used" or "quoted" in the content of the "of" element.
static int SYMBOL_IN_PPMETHOD
          States that the on element is "used" or "quoted" in the content of the "of" element.
static int SYMBOL_IN_PROOF
          States that the on element is "used" or "quoted" in the content of the "of" element.
 String type
           
 
Constructor Summary
MBaseRef.Dependency(MBaseID idOf, String depTypeString, MBaseID idOn)
           
 
Method Summary
 boolean equals(Object o)
           
static String expressDependencyType(int type)
          Directly uses reflexion to find the constant's name from the value.
 String getDependencyTypeString()
           
 MBaseID getIdOf()
           
 MBaseID getIdOn()
           
 MBaseRef.Relation getInverse()
           
 String getPrimaryType()
           
 MBaseID getSourceNodeId()
           
 MBaseID getTargetNodeId()
           
 Collection getTypes()
           
 int hashCode()
           
 boolean isForRelation()
           
 boolean isOccurrenceType()
          Indicates that this relation means an occurrence as used by a ref, textref or OMS elements.
static int recognizeDependency(String depString)
          Directly uses reflexion to find the constant's value.
 String toString()
           
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

SYMBOL_IN_DEFINITION

public static final int SYMBOL_IN_DEFINITION
States that the on element is "used" or "quoted" in the content of the "of" element. If the OMdoc source was properly written, i.e. it did contain a reference to that symbol then the MBase data-entry system will have a not on that definition.

Note that the occurence_in relationship also happens for assertio to be invoked into a proof and so on.

Numbers are attributed so as to ensure that the getType_Of and getType_On method just perform quick residue computations avoiding all case-peeling.

See Also:
Constant Field Values

SYMBOL_IN_ASSERTION

public static final int SYMBOL_IN_ASSERTION
States that the on element is "used" or "quoted" in the content of the "of" element. If the OMdoc source was properly written, i.e. it did contain a reference to that symbol then the MBase data-entry system will have a not on that definition.

Note that the occurence_in relationship also happens for assertio to be invoked into a proof and so on.

Numbers are attributed so as to ensure that the getType_Of and getType_On method just perform quick residue computations avoiding all case-peeling.

See Also:
Constant Field Values

SYMBOL_IN_PROOF

public static final int SYMBOL_IN_PROOF
States that the on element is "used" or "quoted" in the content of the "of" element. If the OMdoc source was properly written, i.e. it did contain a reference to that symbol then the MBase data-entry system will have a not on that definition.

Note that the occurence_in relationship also happens for assertio to be invoked into a proof and so on.

Numbers are attributed so as to ensure that the getType_Of and getType_On method just perform quick residue computations avoiding all case-peeling.

See Also:
Constant Field Values

SYMBOL_IN_METHOD

public static final int SYMBOL_IN_METHOD
States that the on element is "used" or "quoted" in the content of the "of" element. If the OMdoc source was properly written, i.e. it did contain a reference to that symbol then the MBase data-entry system will have a not on that definition.

Note that the occurence_in relationship also happens for assertio to be invoked into a proof and so on.

Numbers are attributed so as to ensure that the getType_Of and getType_On method just perform quick residue computations avoiding all case-peeling.

See Also:
Constant Field Values

SYMBOL_IN_PPMETHOD

public static final int SYMBOL_IN_PPMETHOD
States that the on element is "used" or "quoted" in the content of the "of" element. If the OMdoc source was properly written, i.e. it did contain a reference to that symbol then the MBase data-entry system will have a not on that definition.

Note that the occurence_in relationship also happens for assertio to be invoked into a proof and so on.

Numbers are attributed so as to ensure that the getType_Of and getType_On method just perform quick residue computations avoiding all case-peeling.

See Also:
Constant Field Values

SYMBOL_IN_EXERCISE

public static final int SYMBOL_IN_EXERCISE
States that the on element is "used" or "quoted" in the content of the "of" element. If the OMdoc source was properly written, i.e. it did contain a reference to that symbol then the MBase data-entry system will have a not on that definition.

Note that the occurence_in relationship also happens for assertio to be invoked into a proof and so on.

Numbers are attributed so as to ensure that the getType_Of and getType_On method just perform quick residue computations avoiding all case-peeling.

See Also:
Constant Field Values

SYMBOL_IN_OMTEXT

public static final int SYMBOL_IN_OMTEXT
States that the on element is "used" or "quoted" in the content of the "of" element. If the OMdoc source was properly written, i.e. it did contain a reference to that symbol then the MBase data-entry system will have a not on that definition.

Note that the occurence_in relationship also happens for assertio to be invoked into a proof and so on.

Numbers are attributed so as to ensure that the getType_Of and getType_On method just perform quick residue computations avoiding all case-peeling.

See Also:
Constant Field Values

SYMBOL_IN_EXAMPLE

public static final int SYMBOL_IN_EXAMPLE
States that the on element is "used" or "quoted" in the content of the "of" element. If the OMdoc source was properly written, i.e. it did contain a reference to that symbol then the MBase data-entry system will have a not on that definition.

Note that the occurence_in relationship also happens for assertio to be invoked into a proof and so on.

Numbers are attributed so as to ensure that the getType_Of and getType_On method just perform quick residue computations avoiding all case-peeling.

See Also:
Constant Field Values

DEFINITION_IN_DEFINITION

public static final int DEFINITION_IN_DEFINITION
States that the on element is "used" or "quoted" in the content of the "of" element. If the OMdoc source was properly written, i.e. it did contain a reference to that symbol then the MBase data-entry system will have a not on that definition.

Note that the occurence_in relationship also happens for assertio to be invoked into a proof and so on.

Numbers are attributed so as to ensure that the getType_Of and getType_On method just perform quick residue computations avoiding all case-peeling.

See Also:
Constant Field Values

DEFINITION_IN_ASSERTION

public static final int DEFINITION_IN_ASSERTION
States that the on element is "used" or "quoted" in the content of the "of" element. If the OMdoc source was properly written, i.e. it did contain a reference to that symbol then the MBase data-entry system will have a not on that definition.

Note that the occurence_in relationship also happens for assertio to be invoked into a proof and so on.

Numbers are attributed so as to ensure that the getType_Of and getType_On method just perform quick residue computations avoiding all case-peeling.

See Also:
Constant Field Values

DEFINITION_IN_PROOF

public static final int DEFINITION_IN_PROOF
States that the on element is "used" or "quoted" in the content of the "of" element. If the OMdoc source was properly written, i.e. it did contain a reference to that symbol then the MBase data-entry system will have a not on that definition.

Note that the occurence_in relationship also happens for assertio to be invoked into a proof and so on.

Numbers are attributed so as to ensure that the getType_Of and getType_On method just perform quick residue computations avoiding all case-peeling.

See Also:
Constant Field Values

DEFINITION_IN_METHOD

public static final int DEFINITION_IN_METHOD
States that the on element is "used" or "quoted" in the content of the "of" element. If the OMdoc source was properly written, i.e. it did contain a reference to that symbol then the MBase data-entry system will have a not on that definition.

Note that the occurence_in relationship also happens for assertio to be invoked into a proof and so on.

Numbers are attributed so as to ensure that the getType_Of and getType_On method just perform quick residue computations avoiding all case-peeling.

See Also:
Constant Field Values

DEFINITION_IN_PPMETHOD

public static final int DEFINITION_IN_PPMETHOD
States that the on element is "used" or "quoted" in the content of the "of" element. If the OMdoc source was properly written, i.e. it did contain a reference to that symbol then the MBase data-entry system will have a not on that definition.

Note that the occurence_in relationship also happens for assertio to be invoked into a proof and so on.

Numbers are attributed so as to ensure that the getType_Of and getType_On method just perform quick residue computations avoiding all case-peeling.

See Also:
Constant Field Values

DEFINITION_IN_EXERCISE

public static final int DEFINITION_IN_EXERCISE
States that the on element is "used" or "quoted" in the content of the "of" element. If the OMdoc source was properly written, i.e. it did contain a reference to that symbol then the MBase data-entry system will have a not on that definition.

Note that the occurence_in relationship also happens for assertio to be invoked into a proof and so on.

Numbers are attributed so as to ensure that the getType_Of and getType_On method just perform quick residue computations avoiding all case-peeling.

See Also:
Constant Field Values

DEFINITION_IN_OMTEXT

public static final int DEFINITION_IN_OMTEXT
States that the on element is "used" or "quoted" in the content of the "of" element. If the OMdoc source was properly written, i.e. it did contain a reference to that symbol then the MBase data-entry system will have a not on that definition.

Note that the occurence_in relationship also happens for assertio to be invoked into a proof and so on.

Numbers are attributed so as to ensure that the getType_Of and getType_On method just perform quick residue computations avoiding all case-peeling.

See Also:
Constant Field Values

DEFINITION_IN_EXAMPLE

public static final int DEFINITION_IN_EXAMPLE
States that the on element is "used" or "quoted" in the content of the "of" element. If the OMdoc source was properly written, i.e. it did contain a reference to that symbol then the MBase data-entry system will have a not on that definition.

Note that the occurence_in relationship also happens for assertio to be invoked into a proof and so on.

Numbers are attributed so as to ensure that the getType_Of and getType_On method just perform quick residue computations avoiding all case-peeling.

See Also:
Constant Field Values

ASSERTION_IN_DEFINITION

public static final int ASSERTION_IN_DEFINITION
States that the on element is "used" or "quoted" in the content of the "of" element. If the OMdoc source was properly written, i.e. it did contain a reference to that symbol then the MBase data-entry system will have a not on that definition.

Note that the occurence_in relationship also happens for assertio to be invoked into a proof and so on.

Numbers are attributed so as to ensure that the getType_Of and getType_On method just perform quick residue computations avoiding all case-peeling.

See Also:
Constant Field Values

ASSERTION_IN_ASSERTION

public static final int ASSERTION_IN_ASSERTION
States that the on element is "used" or "quoted" in the content of the "of" element. If the OMdoc source was properly written, i.e. it did contain a reference to that symbol then the MBase data-entry system will have a not on that definition.

Note that the occurence_in relationship also happens for assertio to be invoked into a proof and so on.

Numbers are attributed so as to ensure that the getType_Of and getType_On method just perform quick residue computations avoiding all case-peeling.

See Also:
Constant Field Values

ASSERTION_IN_PROOF

public static final int ASSERTION_IN_PROOF
States that the on element is "used" or "quoted" in the content of the "of" element. If the OMdoc source was properly written, i.e. it did contain a reference to that symbol then the MBase data-entry system will have a not on that definition.

Note that the occurence_in relationship also happens for assertio to be invoked into a proof and so on.

Numbers are attributed so as to ensure that the getType_Of and getType_On method just perform quick residue computations avoiding all case-peeling.

See Also:
Constant Field Values

ASSERTION_IN_METHOD

public static final int ASSERTION_IN_METHOD
States that the on element is "used" or "quoted" in the content of the "of" element. If the OMdoc source was properly written, i.e. it did contain a reference to that symbol then the MBase data-entry system will have a not on that definition.

Note that the occurence_in relationship also happens for assertio to be invoked into a proof and so on.

Numbers are attributed so as to ensure that the getType_Of and getType_On method just perform quick residue computations avoiding all case-peeling.

See Also:
Constant Field Values

ASSERTION_IN_PPMETHOD

public static final int ASSERTION_IN_PPMETHOD
States that the on element is "used" or "quoted" in the content of the "of" element. If the OMdoc source was properly written, i.e. it did contain a reference to that symbol then the MBase data-entry system will have a not on that definition.

Note that the occurence_in relationship also happens for assertio to be invoked into a proof and so on.

Numbers are attributed so as to ensure that the getType_Of and getType_On method just perform quick residue computations avoiding all case-peeling.

See Also:
Constant Field Values

ASSERTION_IN_EXERCISE

public static final int ASSERTION_IN_EXERCISE
States that the on element is "used" or "quoted" in the content of the "of" element. If the OMdoc source was properly written, i.e. it did contain a reference to that symbol then the MBase data-entry system will have a not on that definition.

Note that the occurence_in relationship also happens for assertio to be invoked into a proof and so on.

Numbers are attributed so as to ensure that the getType_Of and getType_On method just perform quick residue computations avoiding all case-peeling.

See Also:
Constant Field Values

ASSERTION_IN_OMTEXT

public static final int ASSERTION_IN_OMTEXT
States that the on element is "used" or "quoted" in the content of the "of" element. If the OMdoc source was properly written, i.e. it did contain a reference to that symbol then the MBase data-entry system will have a not on that definition.

Note that the occurence_in relationship also happens for assertio to be invoked into a proof and so on.

Numbers are attributed so as to ensure that the getType_Of and getType_On method just perform quick residue computations avoiding all case-peeling.

See Also:
Constant Field Values

ASSERTION_IN_EXAMPLE

public static final int ASSERTION_IN_EXAMPLE
States that the on element is "used" or "quoted" in the content of the "of" element. If the OMdoc source was properly written, i.e. it did contain a reference to that symbol then the MBase data-entry system will have a not on that definition.

Note that the occurence_in relationship also happens for assertio to be invoked into a proof and so on.

Numbers are attributed so as to ensure that the getType_Of and getType_On method just perform quick residue computations avoiding all case-peeling.

See Also:
Constant Field Values

PROOF_IN_DEFINITION

public static final int PROOF_IN_DEFINITION
States that the on element is "used" or "quoted" in the content of the "of" element. If the OMdoc source was properly written, i.e. it did contain a reference to that symbol then the MBase data-entry system will have a not on that definition.

Note that the occurence_in relationship also happens for assertio to be invoked into a proof and so on.

Numbers are attributed so as to ensure that the getType_Of and getType_On method just perform quick residue computations avoiding all case-peeling.

See Also:
Constant Field Values

PROOF_IN_ASSERTION

public static final int PROOF_IN_ASSERTION
States that the on element is "used" or "quoted" in the content of the "of" element. If the OMdoc source was properly written, i.e. it did contain a reference to that symbol then the MBase data-entry system will have a not on that definition.

Note that the occurence_in relationship also happens for assertio to be invoked into a proof and so on.

Numbers are attributed so as to ensure that the getType_Of and getType_On method just perform quick residue computations avoiding all case-peeling.

See Also:
Constant Field Values

PROOF_IN_PROOF

public static final int PROOF_IN_PROOF
States that the on element is "used" or "quoted" in the content of the "of" element. If the OMdoc source was properly written, i.e. it did contain a reference to that symbol then the MBase data-entry system will have a not on that definition.

Note that the occurence_in relationship also happens for assertio to be invoked into a proof and so on.

Numbers are attributed so as to ensure that the getType_Of and getType_On method just perform quick residue computations avoiding all case-peeling.

See Also:
Constant Field Values

PROOF_IN_METHOD

public static final int PROOF_IN_METHOD
States that the on element is "used" or "quoted" in the content of the "of" element. If the OMdoc source was properly written, i.e. it did contain a reference to that symbol then the MBase data-entry system will have a not on that definition.

Note that the occurence_in relationship also happens for assertio to be invoked into a proof and so on.

Numbers are attributed so as to ensure that the getType_Of and getType_On method just perform quick residue computations avoiding all case-peeling.

See Also:
Constant Field Values

PROOF_IN_PPMETHOD

public static final int PROOF_IN_PPMETHOD
States that the on element is "used" or "quoted" in the content of the "of" element. If the OMdoc source was properly written, i.e. it did contain a reference to that symbol then the MBase data-entry system will have a not on that definition.

Note that the occurence_in relationship also happens for assertio to be invoked into a proof and so on.

Numbers are attributed so as to ensure that the getType_Of and getType_On method just perform quick residue computations avoiding all case-peeling.

See Also:
Constant Field Values

PROOF_IN_EXERCISE

public static final int PROOF_IN_EXERCISE
States that the on element is "used" or "quoted" in the content of the "of" element. If the OMdoc source was properly written, i.e. it did contain a reference to that symbol then the MBase data-entry system will have a not on that definition.

Note that the occurence_in relationship also happens for assertio to be invoked into a proof and so on.

Numbers are attributed so as to ensure that the getType_Of and getType_On method just perform quick residue computations avoiding all case-peeling.

See Also:
Constant Field Values

PROOF_IN_OMTEXT

public static final int PROOF_IN_OMTEXT
States that the on element is "used" or "quoted" in the content of the "of" element. If the OMdoc source was properly written, i.e. it did contain a reference to that symbol then the MBase data-entry system will have a not on that definition.

Note that the occurence_in relationship also happens for assertio to be invoked into a proof and so on.

Numbers are attributed so as to ensure that the getType_Of and getType_On method just perform quick residue computations avoiding all case-peeling.

See Also:
Constant Field Values

PROOF_IN_EXAMPLE

public static final int PROOF_IN_EXAMPLE
States that the on element is "used" or "quoted" in the content of the "of" element. If the OMdoc source was properly written, i.e. it did contain a reference to that symbol then the MBase data-entry system will have a not on that definition.

Note that the occurence_in relationship also happens for assertio to be invoked into a proof and so on.

Numbers are attributed so as to ensure that the getType_Of and getType_On method just perform quick residue computations avoiding all case-peeling.

See Also:
Constant Field Values

METHOD_IN_DEFINITION

public static final int METHOD_IN_DEFINITION
States that the on element is "used" or "quoted" in the content of the "of" element. If the OMdoc source was properly written, i.e. it did contain a reference to that symbol then the MBase data-entry system will have a not on that definition.

Note that the occurence_in relationship also happens for assertio to be invoked into a proof and so on.

Numbers are attributed so as to ensure that the getType_Of and getType_On method just perform quick residue computations avoiding all case-peeling.

See Also:
Constant Field Values

PPMETHOD_IN_DEFINITION

public static final int PPMETHOD_IN_DEFINITION
States that the on element is "used" or "quoted" in the content of the "of" element. If the OMdoc source was properly written, i.e. it did contain a reference to that symbol then the MBase data-entry system will have a not on that definition.

Note that the occurence_in relationship also happens for assertio to be invoked into a proof and so on.

Numbers are attributed so as to ensure that the getType_Of and getType_On method just perform quick residue computations avoiding all case-peeling.

See Also:
Constant Field Values

METHOD_IN_ASSERTION

public static final int METHOD_IN_ASSERTION
States that the on element is "used" or "quoted" in the content of the "of" element. If the OMdoc source was properly written, i.e. it did contain a reference to that symbol then the MBase data-entry system will have a not on that definition.

Note that the occurence_in relationship also happens for assertio to be invoked into a proof and so on.

Numbers are attributed so as to ensure that the getType_Of and getType_On method just perform quick residue computations avoiding all case-peeling.

See Also:
Constant Field Values

PPMETHOD_IN_ASSERTION

public static final int PPMETHOD_IN_ASSERTION
States that the on element is "used" or "quoted" in the content of the "of" element. If the OMdoc source was properly written, i.e. it did contain a reference to that symbol then the MBase data-entry system will have a not on that definition.

Note that the occurence_in relationship also happens for assertio to be invoked into a proof and so on.

Numbers are attributed so as to ensure that the getType_Of and getType_On method just perform quick residue computations avoiding all case-peeling.

See Also:
Constant Field Values

METHOD_IN_PROOF

public static final int METHOD_IN_PROOF
States that the on element is "used" or "quoted" in the content of the "of" element. If the OMdoc source was properly written, i.e. it did contain a reference to that symbol then the MBase data-entry system will have a not on that definition.

Note that the occurence_in relationship also happens for assertio to be invoked into a proof and so on.

Numbers are attributed so as to ensure that the getType_Of and getType_On method just perform quick residue computations avoiding all case-peeling.

See Also:
Constant Field Values

PPMETHOD_IN_PROOF

public static final int PPMETHOD_IN_PROOF
States that the on element is "used" or "quoted" in the content of the "of" element. If the OMdoc source was properly written, i.e. it did contain a reference to that symbol then the MBase data-entry system will have a not on that definition.

Note that the occurence_in relationship also happens for assertio to be invoked into a proof and so on.

Numbers are attributed so as to ensure that the getType_Of and getType_On method just perform quick residue computations avoiding all case-peeling.

See Also:
Constant Field Values

METHOD_IN_METHOD

public static final int METHOD_IN_METHOD
States that the on element is "used" or "quoted" in the content of the "of" element. If the OMdoc source was properly written, i.e. it did contain a reference to that symbol then the MBase data-entry system will have a not on that definition.

Note that the occurence_in relationship also happens for assertio to be invoked into a proof and so on.

Numbers are attributed so as to ensure that the getType_Of and getType_On method just perform quick residue computations avoiding all case-peeling.

See Also:
Constant Field Values

PPMETHOD_IN_METHOD

public static final int PPMETHOD_IN_METHOD
States that the on element is "used" or "quoted" in the content of the "of" element. If the OMdoc source was properly written, i.e. it did contain a reference to that symbol then the MBase data-entry system will have a not on that definition.

Note that the occurence_in relationship also happens for assertio to be invoked into a proof and so on.

Numbers are attributed so as to ensure that the getType_Of and getType_On method just perform quick residue computations avoiding all case-peeling.

See Also:
Constant Field Values

METHOD_IN_EXERCISE

public static final int METHOD_IN_EXERCISE
States that the on element is "used" or "quoted" in the content of the "of" element. If the OMdoc source was properly written, i.e. it did contain a reference to that symbol then the MBase data-entry system will have a not on that definition.

Note that the occurence_in relationship also happens for assertio to be invoked into a proof and so on.

Numbers are attributed so as to ensure that the getType_Of and getType_On method just perform quick residue computations avoiding all case-peeling.

See Also:
Constant Field Values

PPMETHOD_IN_EXERCISE

public static final int PPMETHOD_IN_EXERCISE
States that the on element is "used" or "quoted" in the content of the "of" element. If the OMdoc source was properly written, i.e. it did contain a reference to that symbol then the MBase data-entry system will have a not on that definition.

Note that the occurence_in relationship also happens for assertio to be invoked into a proof and so on.

Numbers are attributed so as to ensure that the getType_Of and getType_On method just perform quick residue computations avoiding all case-peeling.

See Also:
Constant Field Values

METHOD_IN_OMTEXT

public static final int METHOD_IN_OMTEXT
States that the on element is "used" or "quoted" in the content of the "of" element. If the OMdoc source was properly written, i.e. it did contain a reference to that symbol then the MBase data-entry system will have a not on that definition.

Note that the occurence_in relationship also happens for assertio to be invoked into a proof and so on.

Numbers are attributed so as to ensure that the getType_Of and getType_On method just perform quick residue computations avoiding all case-peeling.

See Also:
Constant Field Values

PPMETHOD_IN_OMTEXT

public static final int PPMETHOD_IN_OMTEXT
States that the on element is "used" or "quoted" in the content of the "of" element. If the OMdoc source was properly written, i.e. it did contain a reference to that symbol then the MBase data-entry system will have a not on that definition.

Note that the occurence_in relationship also happens for assertio to be invoked into a proof and so on.

Numbers are attributed so as to ensure that the getType_Of and getType_On method just perform quick residue computations avoiding all case-peeling.

See Also:
Constant Field Values

METHOD_IN_EXAMPLE

public static final int METHOD_IN_EXAMPLE
States that the on element is "used" or "quoted" in the content of the "of" element. If the OMdoc source was properly written, i.e. it did contain a reference to that symbol then the MBase data-entry system will have a not on that definition.

Note that the occurence_in relationship also happens for assertio to be invoked into a proof and so on.

Numbers are attributed so as to ensure that the getType_Of and getType_On method just perform quick residue computations avoiding all case-peeling.

See Also:
Constant Field Values

PPMETHOD_IN_EXAMPLE

public static final int PPMETHOD_IN_EXAMPLE
States that the on element is "used" or "quoted" in the content of the "of" element. If the OMdoc source was properly written, i.e. it did contain a reference to that symbol then the MBase data-entry system will have a not on that definition.

Note that the occurence_in relationship also happens for assertio to be invoked into a proof and so on.

Numbers are attributed so as to ensure that the getType_Of and getType_On method just perform quick residue computations avoiding all case-peeling.

See Also:
Constant Field Values

EXERCISE_IN_DEFINITION

public static final int EXERCISE_IN_DEFINITION
States that the on element is "used" or "quoted" in the content of the "of" element. If the OMdoc source was properly written, i.e. it did contain a reference to that symbol then the MBase data-entry system will have a not on that definition.

Note that the occurence_in relationship also happens for assertio to be invoked into a proof and so on.

Numbers are attributed so as to ensure that the getType_Of and getType_On method just perform quick residue computations avoiding all case-peeling.

See Also:
Constant Field Values

EXERCISE_IN_ASSERTION

public static final int EXERCISE_IN_ASSERTION
States that the on element is "used" or "quoted" in the content of the "of" element. If the OMdoc source was properly written, i.e. it did contain a reference to that symbol then the MBase data-entry system will have a not on that definition.

Note that the occurence_in relationship also happens for assertio to be invoked into a proof and so on.

Numbers are attributed so as to ensure that the getType_Of and getType_On method just perform quick residue computations avoiding all case-peeling.

See Also:
Constant Field Values

EXERCISE_IN_PROOF

public static final int EXERCISE_IN_PROOF
States that the on element is "used" or "quoted" in the content of the "of" element. If the OMdoc source was properly written, i.e. it did contain a reference to that symbol then the MBase data-entry system will have a not on that definition.

Note that the occurence_in relationship also happens for assertio to be invoked into a proof and so on.

Numbers are attributed so as to ensure that the getType_Of and getType_On method just perform quick residue computations avoiding all case-peeling.

See Also:
Constant Field Values

EXERCISE_IN_METHOD

public static final int EXERCISE_IN_METHOD
States that the on element is "used" or "quoted" in the content of the "of" element. If the OMdoc source was properly written, i.e. it did contain a reference to that symbol then the MBase data-entry system will have a not on that definition.

Note that the occurence_in relationship also happens for assertio to be invoked into a proof and so on.

Numbers are attributed so as to ensure that the getType_Of and getType_On method just perform quick residue computations avoiding all case-peeling.

See Also:
Constant Field Values

EXERCISE_IN_PPMETHOD

public static final int EXERCISE_IN_PPMETHOD
States that the on element is "used" or "quoted" in the content of the "of" element. If the OMdoc source was properly written, i.e. it did contain a reference to that symbol then the MBase data-entry system will have a not on that definition.

Note that the occurence_in relationship also happens for assertio to be invoked into a proof and so on.

Numbers are attributed so as to ensure that the getType_Of and getType_On method just perform quick residue computations avoiding all case-peeling.

See Also:
Constant Field Values

EXERCISE_IN_EXERCISE

public static final int EXERCISE_IN_EXERCISE
States that the on element is "used" or "quoted" in the content of the "of" element. If the OMdoc source was properly written, i.e. it did contain a reference to that symbol then the MBase data-entry system will have a not on that definition.

Note that the occurence_in relationship also happens for assertio to be invoked into a proof and so on.

Numbers are attributed so as to ensure that the getType_Of and getType_On method just perform quick residue computations avoiding all case-peeling.

See Also:
Constant Field Values

EXERCISE_IN_OMTEXT

public static final int EXERCISE_IN_OMTEXT
States that the on element is "used" or "quoted" in the content of the "of" element. If the OMdoc source was properly written, i.e. it did contain a reference to that symbol then the MBase data-entry system will have a not on that definition.

Note that the occurence_in relationship also happens for assertio to be invoked into a proof and so on.

Numbers are attributed so as to ensure that the getType_Of and getType_On method just perform quick residue computations avoiding all case-peeling.

See Also:
Constant Field Values

EXERCISE_IN_EXAMPLE

public static final int EXERCISE_IN_EXAMPLE
States that the on element is "used" or "quoted" in the content of the "of" element. If the OMdoc source was properly written, i.e. it did contain a reference to that symbol then the MBase data-entry system will have a not on that definition.

Note that the occurence_in relationship also happens for assertio to be invoked into a proof and so on.

Numbers are attributed so as to ensure that the getType_Of and getType_On method just perform quick residue computations avoiding all case-peeling.

See Also:
Constant Field Values

OMTEXT_IN_DEFINITION

public static final int OMTEXT_IN_DEFINITION
States that the on element is "used" or "quoted" in the content of the "of" element. If the OMdoc source was properly written, i.e. it did contain a reference to that symbol then the MBase data-entry system will have a not on that definition.

Note that the occurence_in relationship also happens for assertio to be invoked into a proof and so on.

Numbers are attributed so as to ensure that the getType_Of and getType_On method just perform quick residue computations avoiding all case-peeling.

See Also:
Constant Field Values

OMTEXT_IN_ASSERTION

public static final int OMTEXT_IN_ASSERTION
States that the on element is "used" or "quoted" in the content of the "of" element. If the OMdoc source was properly written, i.e. it did contain a reference to that symbol then the MBase data-entry system will have a not on that definition.

Note that the occurence_in relationship also happens for assertio to be invoked into a proof and so on.

Numbers are attributed so as to ensure that the getType_Of and getType_On method just perform quick residue computations avoiding all case-peeling.

See Also:
Constant Field Values

OMTEXT_IN_PROOF

public static final int OMTEXT_IN_PROOF
States that the on element is "used" or "quoted" in the content of the "of" element. If the OMdoc source was properly written, i.e. it did contain a reference to that symbol then the MBase data-entry system will have a not on that definition.

Note that the occurence_in relationship also happens for assertio to be invoked into a proof and so on.

Numbers are attributed so as to ensure that the getType_Of and getType_On method just perform quick residue computations avoiding all case-peeling.

See Also:
Constant Field Values

OMTEXT_IN_METHOD

public static final int OMTEXT_IN_METHOD
States that the on element is "used" or "quoted" in the content of the "of" element. If the OMdoc source was properly written, i.e. it did contain a reference to that symbol then the MBase data-entry system will have a not on that definition.

Note that the occurence_in relationship also happens for assertio to be invoked into a proof and so on.

Numbers are attributed so as to ensure that the getType_Of and getType_On method just perform quick residue computations avoiding all case-peeling.

See Also:
Constant Field Values

OMTEXT_IN_PPMETHOD

public static final int OMTEXT_IN_PPMETHOD
States that the on element is "used" or "quoted" in the content of the "of" element. If the OMdoc source was properly written, i.e. it did contain a reference to that symbol then the MBase data-entry system will have a not on that definition.

Note that the occurence_in relationship also happens for assertio to be invoked into a proof and so on.

Numbers are attributed so as to ensure that the getType_Of and getType_On method just perform quick residue computations avoiding all case-peeling.

See Also:
Constant Field Values

OMTEXT_IN_EXERCISE

public static final int OMTEXT_IN_EXERCISE
States that the on element is "used" or "quoted" in the content of the "of" element. If the OMdoc source was properly written, i.e. it did contain a reference to that symbol then the MBase data-entry system will have a not on that definition.

Note that the occurence_in relationship also happens for assertio to be invoked into a proof and so on.

Numbers are attributed so as to ensure that the getType_Of and getType_On method just perform quick residue computations avoiding all case-peeling.

See Also:
Constant Field Values

OMTEXT_IN_OMTEXT

public static final int OMTEXT_IN_OMTEXT
States that the on element is "used" or "quoted" in the content of the "of" element. If the OMdoc source was properly written, i.e. it did contain a reference to that symbol then the MBase data-entry system will have a not on that definition.

Note that the occurence_in relationship also happens for assertio to be invoked into a proof and so on.

Numbers are attributed so as to ensure that the getType_Of and getType_On method just perform quick residue computations avoiding all case-peeling.

See Also:
Constant Field Values

OMTEXT_IN_EXAMPLE

public static final int OMTEXT_IN_EXAMPLE
States that the on element is "used" or "quoted" in the content of the "of" element. If the OMdoc source was properly written, i.e. it did contain a reference to that symbol then the MBase data-entry system will have a not on that definition.

Note that the occurence_in relationship also happens for assertio to be invoked into a proof and so on.

Numbers are attributed so as to ensure that the getType_Of and getType_On method just perform quick residue computations avoiding all case-peeling.

See Also:
Constant Field Values

EXAMPLE_IN_DEFINITION

public static final int EXAMPLE_IN_DEFINITION
States that the on element is "used" or "quoted" in the content of the "of" element. If the OMdoc source was properly written, i.e. it did contain a reference to that symbol then the MBase data-entry system will have a not on that definition.

Note that the occurence_in relationship also happens for assertio to be invoked into a proof and so on.

Numbers are attributed so as to ensure that the getType_Of and getType_On method just perform quick residue computations avoiding all case-peeling.

See Also:
Constant Field Values

EXAMPLE_IN_ASSERTION

public static final int EXAMPLE_IN_ASSERTION
States that the on element is "used" or "quoted" in the content of the "of" element. If the OMdoc source was properly written, i.e. it did contain a reference to that symbol then the MBase data-entry system will have a not on that definition.

Note that the occurence_in relationship also happens for assertio to be invoked into a proof and so on.

Numbers are attributed so as to ensure that the getType_Of and getType_On method just perform quick residue computations avoiding all case-peeling.

See Also:
Constant Field Values

EXAMPLE_IN_PROOF

public static final int EXAMPLE_IN_PROOF
States that the on element is "used" or "quoted" in the content of the "of" element. If the OMdoc source was properly written, i.e. it did contain a reference to that symbol then the MBase data-entry system will have a not on that definition.

Note that the occurence_in relationship also happens for assertio to be invoked into a proof and so on.

Numbers are attributed so as to ensure that the getType_Of and getType_On method just perform quick residue computations avoiding all case-peeling.

See Also:
Constant Field Values

EXAMPLE_IN_METHOD

public static final int EXAMPLE_IN_METHOD
States that the on element is "used" or "quoted" in the content of the "of" element. If the OMdoc source was properly written, i.e. it did contain a reference to that symbol then the MBase data-entry system will have a not on that definition.

Note that the occurence_in relationship also happens for assertio to be invoked into a proof and so on.

Numbers are attributed so as to ensure that the getType_Of and getType_On method just perform quick residue computations avoiding all case-peeling.

See Also:
Constant Field Values

EXAMPLE_IN_PPMETHOD

public static final int EXAMPLE_IN_PPMETHOD
States that the on element is "used" or "quoted" in the content of the "of" element. If the OMdoc source was properly written, i.e. it did contain a reference to that symbol then the MBase data-entry system will have a not on that definition.

Note that the occurence_in relationship also happens for assertio to be invoked into a proof and so on.

Numbers are attributed so as to ensure that the getType_Of and getType_On method just perform quick residue computations avoiding all case-peeling.

See Also:
Constant Field Values

EXAMPLE_IN_EXERCISE

public static final int EXAMPLE_IN_EXERCISE
States that the on element is "used" or "quoted" in the content of the "of" element. If the OMdoc source was properly written, i.e. it did contain a reference to that symbol then the MBase data-entry system will have a not on that definition.

Note that the occurence_in relationship also happens for assertio to be invoked into a proof and so on.

Numbers are attributed so as to ensure that the getType_Of and getType_On method just perform quick residue computations avoiding all case-peeling.

See Also:
Constant Field Values

EXAMPLE_IN_OMTEXT

public static final int EXAMPLE_IN_OMTEXT
States that the on element is "used" or "quoted" in the content of the "of" element. If the OMdoc source was properly written, i.e. it did contain a reference to that symbol then the MBase data-entry system will have a not on that definition.

Note that the occurence_in relationship also happens for assertio to be invoked into a proof and so on.

Numbers are attributed so as to ensure that the getType_Of and getType_On method just perform quick residue computations avoiding all case-peeling.

See Also:
Constant Field Values

EXAMPLE_IN_EXAMPLE

public static final int EXAMPLE_IN_EXAMPLE
States that the on element is "used" or "quoted" in the content of the "of" element. If the OMdoc source was properly written, i.e. it did contain a reference to that symbol then the MBase data-entry system will have a not on that definition.

Note that the occurence_in relationship also happens for assertio to be invoked into a proof and so on.

Numbers are attributed so as to ensure that the getType_Of and getType_On method just perform quick residue computations avoiding all case-peeling.

See Also:
Constant Field Values

DEFINES

public static final int DEFINES
This relation is from a definition to a symbol to define a symbol. This data is standardly needed by OMdoc

See Also:
Constant Field Values

JUSTIFY_MULTIPLE_DEFINITIONS

public static final int JUSTIFY_MULTIPLE_DEFINITIONS
This relation proves why these definitions define the same symbol The definition is of the symbol on the assertion to prove the equivalence of all definitions. In some cases, this might very well be a pack of several definitions. This data is part of the data of the given proof In the METADATA ??

See Also:
Constant Field Values

ABSTRACTLY_DEPENDS_ON

public static final int ABSTRACTLY_DEPENDS_ON
This relation just mentions a dependency included by the author. It does not have a particular type and reflects the plain tag. This information should be interpreted as a hidden tag for: to be able to read this text, you must read this other.

See Also:
Constant Field Values

PROVES

public static final int PROVES
This relation is from a proof to an assertion Standardly neeeded by OMdoc specs.

See Also:
Constant Field Values

COMMENTS

public static final int COMMENTS
The forWhat of an OMtext: only the type of OMText, the of of the dependency is known.

See Also:
Constant Field Values

EXERCISES

public static final int EXERCISES
The forWhat of an exercise.

See Also:
Constant Field Values

ILLUSTRATES

public static final int ILLUSTRATES
The forWhat of an Example

See Also:
Constant Field Values

IS_SUCH_FOR

public static final int IS_SUCH_FOR
Defines the so-called forWhat type. That is the type of relation used an or "for=" attribute in OMdoc.

See Also:
Constant Field Values

forRelationNames

public final List forRelationNames

idOn

public final MBaseID idOn

idOf

public final MBaseID idOf

type

public final String type
Constructor Detail

MBaseRef.Dependency

public MBaseRef.Dependency(MBaseID idOf,
                           String depTypeString,
                           MBaseID idOn)
Method Detail

getDependencyTypeString

public String getDependencyTypeString()
Returns:
the dependency-type string. This String is interned so that it is possible to compare it with other interned strings with "==" (note, code-written strings are interned)

isForRelation

public boolean isForRelation()

recognizeDependency

public static int recognizeDependency(String depString)
Directly uses reflexion to find the constant's value. Returns -1 if field is not found.

Parameters:
depString - The XML element-name
Returns:
The integer item type

expressDependencyType

public static String expressDependencyType(int type)
Directly uses reflexion to find the constant's name from the value. Returns "(an error message)" if value is not found.

Parameters:
type - the integer item type
Returns:
the OMDoc element-name

getIdOf

public MBaseID getIdOf()
Returns:
the ID of the source of this relation.

getSourceNodeId

public MBaseID getSourceNodeId()
Specified by:
getSourceNodeId in interface MBaseRef.Relation

getIdOn

public MBaseID getIdOn()
Returns:
the ID of the target of this relation.

getTargetNodeId

public MBaseID getTargetNodeId()
Specified by:
getTargetNodeId in interface MBaseRef.Relation

isOccurrenceType

public boolean isOccurrenceType()
Indicates that this relation means an occurrence as used by a ref, textref or OMS elements.

Returns:
true if it is one such (as indicated by the type-string).

toString

public String toString()
Overrides:
toString in class Object

hashCode

public int hashCode()
Overrides:
hashCode in class Object

equals

public boolean equals(Object o)
Overrides:
equals in class Object

getPrimaryType

public String getPrimaryType()
Specified by:
getPrimaryType in interface MBaseRef.Relation

getTypes

public Collection getTypes()
Specified by:
getTypes in interface MBaseRef.Relation

getInverse

public MBaseRef.Relation getInverse()
Specified by:
getInverse in interface MBaseRef.Relation