Navigate (BandM metatools API doc)

java.lang.Object
- eu.bandm.tools.d2d2.base.Navigate

```
public final class Navigate
extends Object
```
Auxiliary static methods for model navigation and inquiry.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`Navigate.CharSetCalc` Under a CharBinary all refs and defs and operators MUST be of character type.
`static class`	`Navigate.LocalReferenceNormalizer` Replaces hard every refering id which is local to some declared object by the normalized identifier, as valid on module level.
`static class`	`Navigate.VisitReachable<T>`

Field Summary

Fields
Modifier and Type	Field and Description
`protected static Function<Definition,Reference>`	`co_resolve`
`static Predicate<Definition>`	`isPublicRegExp`
`static Location<XMLDocumentIdentifier>`	`locnull`
`protected static Function<String,Reference>`	`makeRef`

Constructor Summary

Constructors
Constructor and Description

Navigate()

Constructors
Constructor and Description
`Navigate()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static Set<XRegExp>`	`allPublicXRegExp(Module mod)`
`static Set<XRegExp>`	`allXRegExp(Module mod)`
`static String`	`expandModulePath(ImportItem item)` Deliver the absolute path name for a module which is given by a reference to a module name from some nested scope.
`static String`	`extractSuffix(String s)`
`static @Opt Reference`	`findImplicit(TagsRegExp def)` Find the reference marked as `#implicit`, iff it is the first in a sequence (possibly length 1) on the top of the content model of the given regexp.
`static @Opt Definition`	`findInDefinitions(Module mod, String name)` Look for a definition in a module, including local defs.
`static @Opt Definition`	`findInDefinitions(Module mod, String[] names)` Look for a definition in a module, including local defs.
`static List<Module>`	`getAllModules(SourceItem si)` Delivers the ascending list of containing modules.
`static Module`	`getModule(SourceItem si)`
`static Module`	`getTopmostModule(SourceItem si)`
`static Expression`	`insertedExpression(Insertion ins)`
`static boolean`	`isEmptyXRegExp(Definition def)`
`static boolean`	`isLocalModule(Module mod)`
`static void`	`PP(String text, Object... args)`
`static void`	`printUdom(PrintStream p, Udom u)`
`static void`	`printUdom(Udom u)`
`static String`	`qname(SourceItem si)` Return the qualified name which represents nesting of local definitions up to (and excluding) the module level.
`static String`	`reJoin(String[] names)` Recompose a compound identifier by joining it with `Chars.STRING_NAMING_LEVEL_SEPARATOR` = ,
`static Expression`	`resolveInsertion(Expression exp)`

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

- Field Detail
  - isPublicRegExp
```
public static final Predicate<Definition> isPublicRegExp
```
  - locnull
```
public static final Location<XMLDocumentIdentifier> locnull
```
  - co_resolve
```
protected static final Function<Definition,Reference> co_resolve
```
  - makeRef
```
protected static final Function<String,Reference> makeRef
```
- Constructor Detail
  - Navigate
```
public Navigate()
```
- Method Detail
  - PP
```
public static final void PP(String text,
                            Object... args)
```
  - getModule
```
public static Module getModule(SourceItem si)
```
    Returns:
    
    the module a definition or import item is contained in, or the argument itself, in case its a module itself.
    
    Throws:
    
    MessageException - if argument is not contained in any Module.
  - getTopmostModule
```
public static Module getTopmostModule(SourceItem si)
```
    Returns:
    
    the top-most static (source text level) modual, a definition or import item is contained in, or the argument itself, in case it is a top-level module itself.
    
    Throws:
    
    MessageException - if argument is not contained in any Module.
  - getAllModules
```
public static List<Module> getAllModules(SourceItem si)
```
    Delivers the ascending list of containing modules.
    
    Throws:
    
    MessageException - if argument is not contained in any Module.
  - isLocalModule
```
public static boolean isLocalModule(Module mod)
```
    Returns:
    
    whether the module has been defined at the top of a text input file as a "local" / "spontanuous" / "throw-away" module.
  - qname
```
public static String qname(SourceItem si)
```
    Return the qualified name which represents nesting of local definitions up to (and excluding) the module level.
  - expandModulePath
```
public static String expandModulePath(ImportItem item)
```
    Deliver the absolute path name for a module which is given by a reference to a module name from some nested scope. "childs" and "siblings" of the referring module are considered first. If none is found, the name is considered to be absolute.
    Currently used here and by "Def2Doc". CALLED by Resolver3 (OLD:resolver)
    
    Returns:
    
    the expanded module name = path from top level module to module. This is additionally stored in the field "absolutePath" of the argument.
  - findImplicit
```
@Opt
public static @Opt Reference findImplicit(TagsRegExp def)
```
    Find the reference marked as #implicit, iff it is the first in a sequence (possibly length 1) on the top of the content model of the given regexp.
  - isEmptyXRegExp
```
public static boolean isEmptyXRegExp(Definition def)
```
  - extractSuffix
```
public static String extractSuffix(String s)
```
    Returns:
    
    The part after the last Chars.STRING_NAMING_LEVEL_SEPARATOR = , or the whole String if noneis contained.
  - findInDefinitions
```
@Opt
public static @Opt Definition findInDefinitions(Module mod,
                                                     String name)
```
    Look for a definition in a module, including local defs.
  - findInDefinitions
```
@Opt
public static @Opt Definition findInDefinitions(Module mod,
                                                     String[] names)
```
    Look for a definition in a module, including local defs.
  - reJoin
```
public static String reJoin(String[] names)
```
    Recompose a compound identifier by joining it with Chars.STRING_NAMING_LEVEL_SEPARATOR = ,
    
    Parameters:
    
    names - a non-empty array of identifiers (in the sense of the grammar).
  - allXRegExp
```
public static Set<XRegExp> allXRegExp(Module mod)
```
  - allPublicXRegExp
```
public static Set<XRegExp> allPublicXRegExp(Module mod)
```
  - insertedExpression
```
public static Expression insertedExpression(Insertion ins)
```
  - resolveInsertion
```
public static Expression resolveInsertion(Expression exp)
```
  - printUdom
```
public static void printUdom(Udom u)
```
  - printUdom
```
public static void printUdom(PrintStream p,
                             Udom u)
```

Class Navigate

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

isPublicRegExp

locnull

co_resolve

makeRef

Constructor Detail

Navigate

Method Detail

PP

getModule

getTopmostModule

getAllModules

isLocalModule

qname

expandModulePath

findImplicit

isEmptyXRegExp

extractSuffix

findInDefinitions

findInDefinitions

reJoin

allXRegExp

allPublicXRegExp

insertedExpression

resolveInsertion

printUdom

printUdom