class DerivedDeclaration extends Declaration with DerivedContentElement
a declarations that is elaborated into more primitive declarations
- Source
- DerivedDeclaration.scala
- Alphabetic
- By Inheritance
- DerivedDeclaration
- DerivedContentElement
- HasNotation
- HasType
- AbstractTheory
- ModuleOrLink
- HasDefiniens
- ContainerElement
- MutableElementContainer
- ElementContainer
- Declaration
- ContentElement
- StructuralElement
- NamedElement
- Content
- ClientProperties
- HasMetaData
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Instance Constructors
- new DerivedDeclaration(home: Term, name: LocalName, feature: String, tpC: TermContainer, notC: NotationContainer, dfC: TermContainer = TermContainer(None))
Type Members
-
type
ThisType = DerivedDeclaration
to allow for sharper types of fields, every subclass of Declaration defines this to be itself
to allow for sharper types of fields, every subclass of Declaration defines this to be itself
- Definition Classes
- DerivedDeclaration → Declaration
Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
add(d: Declaration, at: AddPosition = AtEnd): Unit
adds a named declaration, throws exception if name already declared
adds a named declaration, throws exception if name already declared
- d
declaration to add
- at
the position where to add, at end by default this throws an errors if a declaration for that name already exists; exception: if the two declarations are equivalent, the old one is overridden
- Definition Classes
- ModuleOrLink → MutableElementContainer
-
def
addAfterNarrative(d: Declaration, after: LocalName): Unit
like add, but treats the second argument as the name of a NarrativeElement
like add, but treats the second argument as the name of a NarrativeElement
- Definition Classes
- ModuleOrLink
-
def
alternativeNames: List[LocalName]
an alternative name
an alternative name
None by default; overridden in particular by Constant
- Definition Classes
- Declaration
-
def
asDocument: Document
the narrative structure
the narrative structure
- Definition Classes
- ModuleOrLink
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
lazy val
clientProperty: ListMap[URI, Any]
- Definition Classes
- ClientProperties
-
def
clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
def
compatible(that: StructuralElement): Boolean
two StructuralElement's are compatible if they have the same type, same Path, and agree in all parts that are TermContainer's
two StructuralElement's are compatible if they have the same type, same Path, and agree in all parts that are TermContainer's
- Definition Classes
- StructuralElement
-
def
declares(name: LocalName): Boolean
true iff a declaration for a name is present
true iff a declaration for a name is present
- Definition Classes
- ModuleOrLink
-
def
delete(name: LocalName): Option[Declaration]
delete a named declaration (does not have to exist)
delete a named declaration (does not have to exist)
- returns
the deleted declaration
- Definition Classes
- ModuleOrLink → MutableElementContainer
-
def
df: Option[Term]
- Definition Classes
- HasDefiniens
-
val
dfC: TermContainer
- Definition Classes
- DerivedDeclaration → HasDefiniens
-
def
dfNode: Seq[Node] with AbstractSeq[Node] with Serializable
- Definition Classes
- HasDefiniens
-
def
documentHome: DPath
- Definition Classes
- Declaration
-
def
domain: List[LocalName]
the list of names of all declarations
the list of names of all declarations
- Definition Classes
- ModuleOrLink → ElementContainer
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
equivalentTo(that: StructuralElement): Boolean
logically equivalent: compares headerInfo, components, and declarations
logically equivalent: compares headerInfo, components, and declarations
- Definition Classes
- StructuralElement
-
val
feature: String
the kind of declaration, e.g., "constant"
the kind of declaration, e.g., "constant"
- Definition Classes
- DerivedDeclaration → ContentElement → StructuralElement
-
def
finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
def
foreachComponent(f: (CPath, ComponentContainer) ⇒ Unit): Unit
recursively applies a function to all components in this element (in declaration order)
recursively applies a function to all components in this element (in declaration order)
- Definition Classes
- ContentElement
-
def
foreachDeclaration(f: (ContentElement) ⇒ Unit): Unit
recursively applies a function to all declarations in this element (in declaration order)
recursively applies a function to all declarations in this element (in declaration order)
- Definition Classes
- ContentElement
-
def
get(name: LocalName): Declaration
- Definition Classes
- ElementContainer
-
def
getAllIncludes: List[IncludeData]
like getIncludes but also with includes of parametric theories and defined includes
like getIncludes but also with includes of parametric theories and defined includes
- Definition Classes
- AbstractTheory → ModuleOrLink
-
def
getAllIncludesWithSelf: List[IncludeData]
Get all transitive-reflexive inclusions.
Get all transitive-reflexive inclusions.
- Definition Classes
- ModuleOrLink
-
def
getAllIncludesWithoutMeta: List[IncludeData]
like getIncludesWithoutMeta but also with includes of parametric theories and their instantiations
like getIncludesWithoutMeta but also with includes of parametric theories and their instantiations
- Definition Classes
- AbstractTheory
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
def
getComponent(k: ComponentKey): Option[ComponentContainer]
returns a specific component if present
returns a specific component if present
- Definition Classes
- StructuralElement
-
def
getComponentContext(k: ComponentKey): Context
like getComponent but returns the additional context (in addition to the context of the element) of the component, empty by default, override as needed unspecified if the component does not exist
like getComponent but returns the additional context (in addition to the context of the element) of the component, empty by default, override as needed unspecified if the component does not exist
- Definition Classes
- StructuralElement
-
def
getComponents: List[DeclarationComponent]
returns all term components of this elements
returns all term components of this elements
- Definition Classes
- DerivedContentElement → StructuralElement
-
def
getConstants: List[Constant]
convenience method to obtain all constants
convenience method to obtain all constants
- Definition Classes
- AbstractTheory
-
def
getDeclarations: List[Declaration]
the list of declarations in narrative order, includes generated declarations
the list of declarations in narrative order, includes generated declarations
- Definition Classes
- ModuleOrLink → ElementContainer → ContentElement → StructuralElement
-
def
getDeclarationsBefore(n: LocalName): List[Declaration]
- Definition Classes
- ElementContainer
-
def
getDeclarationsElaborated: List[Declaration]
the list of declarations using elaborated declarations where possible these are: primitive elements: includes, constants other elements if they have not been fully elaborated
the list of declarations using elaborated declarations where possible these are: primitive elements: includes, constants other elements if they have not been fully elaborated
- Definition Classes
- ContainerElement
-
def
getDerivedDeclarations(f: String): List[DerivedDeclaration]
convenience method to obtain all derived declarations for a given feature
convenience method to obtain all derived declarations for a given feature
- Definition Classes
- AbstractTheory
-
def
getIncludes: List[MPath]
convenience method to obtain all included theories (including a possible meta-theory)
convenience method to obtain all included theories (including a possible meta-theory)
- Definition Classes
- AbstractTheory
-
def
getIncludesWithoutMeta: List[MPath]
convenience method to obtain all included theories (without a possible meta-theory)
convenience method to obtain all included theories (without a possible meta-theory)
- Definition Classes
- AbstractTheory
-
def
getInnerContext: Context
the context governing the body: meta-theory, parameters, and this theory
the context governing the body: meta-theory, parameters, and this theory
- Definition Classes
- AbstractTheory → ModuleOrLink
-
def
getMetaDataNode: NodeSeq
- Definition Classes
- HasMetaData
-
def
getMostSpecific(name: LocalName): Option[(Declaration, LocalName)]
- Definition Classes
- ModuleOrLink → ElementContainer
-
def
getNamedStructures: List[Structure]
convenience method to obtain all named structures
convenience method to obtain all named structures
- Definition Classes
- AbstractTheory
-
def
getO(name: LocalName): Option[Declaration]
retrieve a declaration
retrieve a declaration
- Definition Classes
- ModuleOrLink → ElementContainer
-
def
getO(name: String): Option[Declaration]
same as get(LocalName(name))
same as get(LocalName(name))
- Definition Classes
- ElementContainer
-
def
getOrigin: Origin
- Definition Classes
- StructuralElement
-
def
getPrimitiveDeclarations: List[Declaration]
the list of declarations in the order of addition, excludes generated declarations
the list of declarations in the order of addition, excludes generated declarations
- Definition Classes
- ContainerElement
-
def
getRealizees: List[IncludeData]
return all includes that are realizations
return all includes that are realizations
- Definition Classes
- AbstractTheory
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
def
headerInfo: HeaderInfo
header information of this elements includes the MMT types (e.g., domain, codomain of links) but not the logical types of constants
header information of this elements includes the MMT types (e.g., domain, codomain of links) but not the logical types of constants
- Definition Classes
- StructuralElement
-
def
headerNodes: Seq[Node]
common inner nodes: definiens (metadata is part of document)
common inner nodes: definiens (metadata is part of document)
- Attributes
- protected
- Definition Classes
- ModuleOrLink
-
val
home: Term
the containing module
the containing module
this is almost always OMMOD(p:MPath), the main exception are generated anonymous modules
- Definition Classes
- DerivedDeclaration → Declaration
-
def
innerNodes: NodeSeq
getPrimitiveDeclarations, with narrative structure
getPrimitiveDeclarations, with narrative structure
- Attributes
- protected
- Definition Classes
- ModuleOrLink
-
def
innerNodesElab: List[Node]
getDeclarationsElaborated, without narrative structure
getDeclarationsElaborated, without narrative structure
- Attributes
- protected
- Definition Classes
- ModuleOrLink
-
def
innerString: String
body as a string
body as a string
- Definition Classes
- ModuleOrLink
-
def
isDeclared(name: LocalName): Boolean
- Definition Classes
- ElementContainer
-
def
isEmpty: Boolean
true iff no declarations present
true iff no declarations present
- Definition Classes
- ModuleOrLink
-
def
isGenerated: Boolean
- Definition Classes
- StructuralElement
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
def
merge(that: Declaration): Nothing
a new declaration with the same path obtained by replacing fields in 'this' with corresponding fields of 'that' Unfortunately, this must take any declaration and throw an error if 'not (that : ThisType)'
a new declaration with the same path obtained by replacing fields in 'this' with corresponding fields of 'that' Unfortunately, this must take any declaration and throw an error if 'not (that : ThisType)'
- Definition Classes
- DerivedDeclaration → Declaration
-
def
merge(that: StructuralElement): Unit
merge all properties of 'that' into 'this' except for components and declarations
merge all properties of 'that' into 'this' except for components and declarations
- Definition Classes
- Declaration → StructuralElement
-
def
mergeError(that: Declaration): Nothing
called to throw an error from within 'merge'
called to throw an error from within 'merge'
- Attributes
- protected
- Definition Classes
- Declaration
-
def
meta: None.type
the meta-theory
the meta-theory
- Definition Classes
- DerivedDeclaration → AbstractTheory
-
val
metadata: MetaData
- Definition Classes
- HasMetaData
- val module: DerivedDeclaration
-
def
modulePath: MPath
path if seen as a module
path if seen as a module
- Definition Classes
- ModuleOrLink
-
val
name: LocalName
the local name in the containing module
the local name in the containing module
for symbols: the name of the symbols
for assignments: the name of the symbols to which a value is assigned
- Definition Classes
- DerivedDeclaration → Declaration → ContentElement → NamedElement
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
not: Option[TextNotation]
- Definition Classes
- HasNotation
-
val
notC: NotationContainer
- Definition Classes
- DerivedDeclaration → HasNotation
-
def
notNode: Seq[Node] with AbstractSeq[Node] with Serializable
- Definition Classes
- HasNotation
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
def
outerString: String
header as a string (without definiens)
header as a string (without definiens)
- Definition Classes
- DerivedContentElement → ModuleOrLink
-
def
parameters: Context
always empty for now, could be relaxed in the future
always empty for now, could be relaxed in the future
- Definition Classes
- DerivedContentElement → AbstractTheory
-
lazy val
parent: MPath
the containing module
the containing module
- Definition Classes
- Declaration → StructuralElement
-
def
path: GlobalName
the full MMT URI, parent ? name
the full MMT URI, parent ? name
- Definition Classes
- Declaration → ContentElement → StructuralElement
-
def
primaryNameAndAliases: (LocalName, List[LocalName])
- returns
the shortest name and all other names
- Definition Classes
- Declaration
-
def
relativeDocumentHome: LocalName
- Definition Classes
- Declaration
-
def
reorder(ln: LocalName): Unit
moves a declaration to the end of its section (if the relDocHome of ln has changed, it is also moved to the new section) also moves all subsequent ln/X declarations (and updates their relDocHome)
moves a declaration to the end of its section (if the relDocHome of ln has changed, it is also moved to the new section) also moves all subsequent ln/X declarations (and updates their relDocHome)
- Definition Classes
- ModuleOrLink → MutableElementContainer
-
def
selfInclude: IncludeData
Get self inclusion.
Get self inclusion.
- Definition Classes
- AbstractTheory → ModuleOrLink
-
def
setDocumentHome(ln: LocalName): Unit
- Definition Classes
- Declaration
-
def
setOrigin(o: Origin): Unit
- Definition Classes
- StructuralElement
-
val
statements: HashMap[LocalName, Declaration]
the set of named statements, indexed by name if a statement has an alternativeName, it occurs twice in this map
the set of named statements, indexed by name if a statement has an alternativeName, it occurs twice in this map
- Attributes
- protected
- Definition Classes
- ModuleOrLink
-
def
streamInnerNodes(rh: RenderingHandler): Unit
- Definition Classes
- ModuleOrLink
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toNode(rh: RenderingHandler): Unit
by default, this prints out toNode
by default, this prints out toNode
potentially large StructuralElements should override it with a memory-efficient implementation
- Definition Classes
- DerivedContentElement → Content
-
def
toNode: Elem
XML representation
XML representation
- Definition Classes
- DerivedContentElement → Content
-
def
toString(): String
outerString, definiens, innerString
outerString, definiens, innerString
- Definition Classes
- ModuleOrLink → AnyRef → Any
-
def
toTerm: OMID
the OMS referencing this declaration
the OMS referencing this declaration
- Definition Classes
- Declaration → ContentElement
-
def
tp: Option[Term]
- Definition Classes
- HasType
-
val
tpC: TermContainer
- Definition Classes
- DerivedDeclaration → HasType
-
def
tpNode: Seq[Node] with AbstractSeq[Node] with Serializable
- Definition Classes
- HasType
-
def
translate(newHome: Term, prefix: LocalName, tl: Translator, con: Context): DerivedDeclaration
a recursively translated copy of this declaration with a URI
a recursively translated copy of this declaration with a URI
- newHome
the home theory of the result
- prefix
the prefix used to form the name of the new declaration
- Definition Classes
- DerivedDeclaration → Declaration
-
def
translate(translator: Translator, context: Context): ThisType
a recursively translated copy of this declaration
a recursively translated copy of this declaration
- Definition Classes
- Declaration
-
def
translateDf(translator: Translator, context: Context): TermContainer
- Definition Classes
- HasDefiniens
-
def
translateTp(translator: Translator, context: Context): TermContainer
- Definition Classes
- HasType
-
def
update(s: Declaration): Unit
updates a named declaration (preserving the order)
updates a named declaration (preserving the order)
- Definition Classes
- ModuleOrLink → MutableElementContainer
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()