Class

org.clulab.reach.assembly.representations

Regulation

Related Doc: package representations

Permalink

class Regulation extends ComplexEvent

Representation of a Regulation.

Linear Supertypes
ComplexEvent, Event, EntityEventRepresentation, Serializable, Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Regulation
  2. ComplexEvent
  3. Event
  4. EntityEventRepresentation
  5. Serializable
  6. Serializable
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Regulation(uniqueID: IDPointer, controllerPointers: Set[IDPointer], controlledPointers: Set[IDPointer], polarity: String, sourceMention: Option[Mention], manager: AssemblyManager)

    Permalink

    uniqueID

    the IDPointer assigned to this Regulation

    controllerPointers

    a Set of IDPointer corresponding to the Mentions serving as controllers to the Regulation
    It is a set because each Mention of a Regulation may have more than one controller, and each Mention contained in AssemblyManager.mentionToID points to exactly one IDPointer which corresponds to exactly one EntityEventRepresentation in AssemblyManager.idToEER

    controlledPointers

    a Set of IDPointer corresponding to the Mentions serving as the controlled to the Regulation
    It is a set because each Mention of a Regulation may have more than one controlled, and each Mention contained in AssemblyManager.mentionToID points to exactly one IDPointer which corresponds to exactly one EntityEventRepresentation in AssemblyManager.idToEER

    polarity

    whether the Regulation is AssemblyManager.positive, AssemblyManager.negative, or AssemblyManager.unknown

    sourceMention

    the Mention from which this Regulation was constructed

    manager

    a pointer to the AssemblyManager instance that produced this Regulation

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. def I: Set[Entity]

    Permalink

    Get the entities (patients) serving as input to the event

    Get the entities (patients) serving as input to the event

    Definition Classes
    ComplexEventEvent
  5. def O: Set[Entity]

    Permalink

    Get the entities (transformed patients) serving as output to the event

    Get the entities (transformed patients) serving as output to the event

    Definition Classes
    ComplexEventEvent
  6. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  7. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  8. def containsID(someID: IDPointer): Boolean

    Permalink

    Whether or not the ComplexEvent contains the provided IDPointer.

    Whether or not the ComplexEvent contains the provided IDPointer.

    someID

    an IDPointer identifying some EntityEventRepresentation

    returns

    true or false

    Definition Classes
    ComplexEventEntityEventRepresentation
  9. def controlled: Set[EntityEventRepresentation]

    Permalink

    The EntityEventRepresentation Set corresponding to the referencing Regulation Mention's "controlled" argument (retrieved using using the manager.idToEER and the controlledPointers).

    The EntityEventRepresentation Set corresponding to the referencing Regulation Mention's "controlled" argument (retrieved using using the manager.idToEER and the controlledPointers).

    returns

    a Set of EntityEventRepresentation

    Definition Classes
    ComplexEvent
  10. def controlledHash: Int

    Permalink

    Hash representing the controlled.

    Hash representing the controlled.
    Used by equivalenceHash for isEquivalentTo comparisons.

    returns

    an Int hash based on the EntityEventRepresentation.equivalenceHash of each element in the controlled

    Definition Classes
    ComplexEvent
  11. val controlledPointers: Set[IDPointer]

    Permalink

    a Set of IDPointer corresponding to the Mentions serving as the controlled to the Regulation
    It is a set because each Mention of a Regulation may have more than one controlled, and each Mention contained in AssemblyManager.mentionToID points to exactly one IDPointer which corresponds to exactly one EntityEventRepresentation in AssemblyManager.idToEER

    a Set of IDPointer corresponding to the Mentions serving as the controlled to the Regulation
    It is a set because each Mention of a Regulation may have more than one controlled, and each Mention contained in AssemblyManager.mentionToID points to exactly one IDPointer which corresponds to exactly one EntityEventRepresentation in AssemblyManager.idToEER

    Definition Classes
    RegulationComplexEvent
  12. def controller: Set[EntityEventRepresentation]

    Permalink

    The EntityEventRepresentation Set corresponding to the referencing Regulation Mention's "controller" argument (retrieved using using the manager.idToEER and the controllerPointers).

    The EntityEventRepresentation Set corresponding to the referencing Regulation Mention's "controller" argument (retrieved using using the manager.idToEER and the controllerPointers).

    returns

    a Set of EntityEventRepresentation

    Definition Classes
    ComplexEvent
  13. def controllerHash: Int

    Permalink

    Hash representing the controller.

    Hash representing the controller.
    Used by equivalenceHash for isEquivalentTo comparisons.

    returns

    an Int hash based on the EntityEventRepresentation.equivalenceHash of each element in the controller

    Definition Classes
    ComplexEvent
  14. val controllerPointers: Set[IDPointer]

    Permalink

    a Set of IDPointer corresponding to the Mentions serving as controllers to the Regulation
    It is a set because each Mention of a Regulation may have more than one controller, and each Mention contained in AssemblyManager.mentionToID points to exactly one IDPointer which corresponds to exactly one EntityEventRepresentation in AssemblyManager.idToEER

    a Set of IDPointer corresponding to the Mentions serving as controllers to the Regulation
    It is a set because each Mention of a Regulation may have more than one controller, and each Mention contained in AssemblyManager.mentionToID points to exactly one IDPointer which corresponds to exactly one EntityEventRepresentation in AssemblyManager.idToEER

    Definition Classes
    RegulationComplexEvent
  15. def coref: Boolean

    Permalink

    Whether or not the EntityEventRepresentation was produced by a Mention resolved through coref.

    Whether or not the EntityEventRepresentation was produced by a Mention resolved through coref.

    returns

    true or false

    Definition Classes
    EntityEventRepresentation
  16. def distinctPredecessors: Set[EntityEventRepresentation]

    Permalink

    Distinct causal predecessors of this Event

    Distinct causal predecessors of this Event

    Definition Classes
    Event
  17. def distinctSuccessors: Set[EntityEventRepresentation]

    Permalink

    Distinct causal successors of this Event

    Distinct causal successors of this Event

    Definition Classes
    Event
  18. val eerString: String

    Permalink
  19. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  20. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  21. def equivalenceHash: Int

    Permalink

    Used by isEquivalentTo to compare against another ComplexEvent.

    Used by isEquivalentTo to compare against another ComplexEvent.

    returns

    an Int hash based on the polarity, controllerHash, controlledHash, and negated.hashCode

    Definition Classes
    ComplexEventEntityEventRepresentation
  22. def equivalentPredecessors: Set[EntityEventRepresentation]

    Permalink

    Equivalent causal predecessors of this Event

    Equivalent causal predecessors of this Event

    Definition Classes
    Event
  23. def equivalentSuccessors: Set[EntityEventRepresentation]

    Permalink

    Equivalent causal successors of this Event

    Equivalent causal successors of this Event

    Definition Classes
    Event
  24. def evidence: Set[Mention]

    Permalink

    The Set of Mentions serving as textual evidence for this EntityEventRepresentation.

    The Set of Mentions serving as textual evidence for this EntityEventRepresentation.

    returns

    Set[Mention]

    Definition Classes
    EntityEventRepresentation
  25. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  26. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  27. def hasApproximateArgument(arg: SimpleEntity): Boolean

    Permalink

    Checks if SimpleEntity argument is contained in the event.

    Checks if SimpleEntity argument is contained in the event.
    Only requires grounding id to match.

    Definition Classes
    ComplexEventEvent
  28. def hasCorefResolution(m: Mention): Boolean

    Permalink

    Checks to see if a coref mention has an antecedent.

    Checks to see if a coref mention has an antecedent.

    If the mentions made it through the coref component of reach, the only mentions that might have an antecedent should be those with a "Generic_*"
    this is just a broader, fail-safe check...

    m

    an Odin Mention

    returns

    true if cm has an antecedent; false otherwise

    Definition Classes
    EntityEventRepresentation
  29. def hasExactArgument(arg: EntityEventRepresentation): Boolean

    Permalink

    Checks if argument (including its mods) is contained in the event *

    Checks if argument (including its mods) is contained in the event *

    Definition Classes
    ComplexEventEvent
  30. def hasNegation(m: Mention): Boolean

    Permalink

    Checks whether evidence contains a Negation modification

    Checks whether evidence contains a Negation modification

    m

    an Odin Mention

    returns

    true or false

    Definition Classes
    EntityEventRepresentation
  31. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  32. def isEquivalentTo(other: Any): Boolean

    Permalink

    Used to compare against another ComplexEvent.

    Used to compare against another ComplexEvent.
    Based on the equality of equivalenceHash to that of another ComplexEvent.

    other

    the thing to compare against

    returns

    true or false

    Definition Classes
    ComplexEventEntityEventRepresentation
  33. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  34. val manager: AssemblyManager

    Permalink

    a pointer to the AssemblyManager instance that produced this Regulation

    a pointer to the AssemblyManager instance that produced this Regulation

    Definition Classes
    RegulationComplexEventEntityEventRepresentation
  35. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  36. def negated: Boolean

    Permalink

    Whether or not the EntityEventRepresentation is negated by its evidence (i.e., whether or not the evidence gives a negative example for this EntityEventRepresentation).

    Whether or not the EntityEventRepresentation is negated by its evidence (i.e., whether or not the evidence gives a negative example for this EntityEventRepresentation).

    returns

    true or false

    Definition Classes
    EntityEventRepresentation
  37. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  38. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  39. val polarity: String

    Permalink

    whether the Regulation is AssemblyManager.positive, AssemblyManager.negative, or AssemblyManager.unknown

  40. def precedenceRelations: Set[PrecedenceRelation]

    Permalink

    PrecedenceRelations for this Event

    PrecedenceRelations for this Event

    Definition Classes
    Event
  41. def predecessors: Set[EntityEventRepresentation]

    Permalink

    Causal predecessors of this Event

    Causal predecessors of this Event

    Definition Classes
    Event
  42. val sourceMention: Option[Mention]

    Permalink

    the Mention from which this Regulation was constructed

    the Mention from which this Regulation was constructed

    Definition Classes
    RegulationComplexEventEntityEventRepresentation
  43. def successors: Set[EntityEventRepresentation]

    Permalink

    Causal successors of this Event

    Causal successors of this Event

    Definition Classes
    Event
  44. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  45. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  46. val uniqueID: IDPointer

    Permalink

    the IDPointer assigned to this Regulation

    the IDPointer assigned to this Regulation

    Definition Classes
    RegulationComplexEventEntityEventRepresentation
  47. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  48. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  49. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from ComplexEvent

Inherited from Event

Inherited from EntityEventRepresentation

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped