Class AceReader

  • All Implemented Interfaces:
    org.apache.uima.collection.base_cpm.BaseCollectionReader, org.apache.uima.collection.CollectionReader, org.apache.uima.resource.ConfigurableResource, org.apache.uima.resource.Resource

    public class AceReader
    extends org.apache.uima.collection.CollectionReader_ImplBase
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String ELEMENT_ANCHOR
      XML element of content anchor
      static java.lang.String ELEMENT_BODY
      XML element of content BODY
      static java.lang.String ELEMENT_CHARSEQ
      XML element of content charseq
      static java.lang.String ELEMENT_DOCUMENT
      XML element of content document
      static java.lang.String ELEMENT_ENTITY
      XML element of content entity
      static java.lang.String ELEMENT_ENTITY_ATTRIBUTES
      XML element of content entity_attributes
      static java.lang.String ELEMENT_ENTITY_MENTION
      XML element of content entity_mention
      static java.lang.String ELEMENT_EVENT
      XML element of content event
      static java.lang.String ELEMENT_EVENT_ARGUMENT
      XML element of content event_argument
      static java.lang.String ELEMENT_EVENT_MENTION
      XML element of content event_mention
      static java.lang.String ELEMENT_EVENT_MENTION_ARGUMENT
      XML element of content event_mention_argument
      static java.lang.String ELEMENT_EXTENT
      XML element of content extent
      static java.lang.String ELEMENT_HEAD
      XML element of content head
      static java.lang.String ELEMENT_LDC_SCOPE
      XML element of content ldc_scope
      static java.lang.String ELEMENT_NAME
      XML element of content name
      static java.lang.String ELEMENT_RELATION
      XML element of content relation
      static java.lang.String ELEMENT_RELATION_ARGUMENT
      XML element of content relation_argument
      static java.lang.String ELEMENT_RELATION_MENTION
      XML element of content relation_mention
      static java.lang.String ELEMENT_RELATION_MENTION_ARGUMENT
      XML element of content relation_mention_argument
      static java.lang.String ELEMENT_SOURCE_FILE
      XML element of content source_file
      static java.lang.String ELEMENT_TEXT
      XML element of content TEXT
      static java.lang.String ELEMENT_TIMEX2
      XML element of content timex2
      static java.lang.String ELEMENT_TIMEX2_MENTION
      XML element of content timex2_mention
      static java.lang.String ELEMENT_VALUE
      XML element of content value
      static java.lang.String ELEMENT_VALUE_MENTION
      XML element of content value_mention
      static java.lang.String GENERATE_JCORE_TYPES  
      static java.lang.String ITEM_ANCHOR_DIR
      XML item of content ANCHOR_DIR
      static java.lang.String ITEM_ANCHOR_VAL
      XML item of content ANCHOR_VAL
      static java.lang.String ITEM_AUTHOR
      XML item of content AUTHOR
      static java.lang.String ITEM_CLASS
      XML item of content CLASS
      static java.lang.String ITEM_COMMENT
      XML item of content COMMENT
      static java.lang.String ITEM_DOCID
      XML item of content DOCID
      static java.lang.String ITEM_ENCODING
      XML item of content ENCODING
      static java.lang.String ITEM_END
      XML item of content END
      static java.lang.String ITEM_GENERICITY
      XML item of content GENERICITY
      static java.lang.String ITEM_ID
      XML item of content ID
      static java.lang.String ITEM_LDCATR
      XML item of content LDCATR
      static java.lang.String ITEM_LDCTYPE
      XML item of content LDCTYPE
      static java.lang.String ITEM_LEVEL
      XML item of content LEVEL
      static java.lang.String ITEM_LEXICALCONDITION
      XML item of content LEXICALCONDITION
      static java.lang.String ITEM_METONYMY_MENTION
      XML item of content METONYMY_MENTION
      static java.lang.String ITEM_MOD
      XML item of content MOD
      static java.lang.String ITEM_MODALITY
      XML item of content MODALITY
      static java.lang.String ITEM_NON_SPECIFIC
      XML item of content NON_SPECIFIC
      static java.lang.String ITEM_POLARITY
      XML item of content POLARITY
      static java.lang.String ITEM_REFID
      XML item of content REFID
      static java.lang.String ITEM_ROLE
      XML item of content ROLE
      static java.lang.String ITEM_SET
      XML item of content SET
      static java.lang.String ITEM_SOURCE
      XML item of content SOURCE
      static java.lang.String ITEM_START
      XML item of content START
      static java.lang.String ITEM_SUBTYPE
      XML item of content SUBTYPE
      static java.lang.String ITEM_TENSE
      XML item of content TENSE
      static java.lang.String ITEM_TYPE
      XML item of content TYPE
      static java.lang.String ITEM_URI
      XML item of content URI
      static java.lang.String ITEM_VAL
      XML item of content VAL
      static java.lang.String PARAM_INPUTDIR
      Name of configuration parameter that must be set to the path of a directory containing input files.
      • Fields inherited from interface org.apache.uima.resource.Resource

        PARAM_AGGREGATE_SOFA_MAPPINGS, PARAM_CONFIG_MANAGER, PARAM_CONFIG_PARAM_SETTINGS, PARAM_EXTERNAL_OVERRIDE_SETTINGS, PARAM_PERFORMANCE_TUNING_SETTINGS, PARAM_RESOURCE_MANAGER, PARAM_UIMA_CONTEXT
    • Constructor Summary

      Constructors 
      Constructor Description
      AceReader()  
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void addDocumentInformation​(org.w3c.dom.Node documentNode, de.julielab.jcore.types.ace.Document aceDocument, org.apache.uima.jcas.JCas jcas)
      This method is used to put the document information of the XML file into the proper object of the AceTypeSystem.
      void addEntityInformation​(org.w3c.dom.Node entityNode, de.julielab.jcore.types.ace.Entity aceEntity, org.apache.uima.jcas.JCas jcas)
      This method is used to put the entities from the XML file into proper objects of the AceTypeSystem
      void addEventInformation​(org.w3c.dom.Node eventNode, de.julielab.jcore.types.ace.Event aceEvent, org.apache.uima.jcas.JCas jcas)
      This method is used to put the event information from the XML file into proper objects of the AceTypeSystem
      void addRelationInformation​(org.w3c.dom.Node relationNode, de.julielab.jcore.types.ace.Relation aceRelation, org.apache.uima.jcas.JCas jcas)
      This method is used to put the relation information from the XML file into proper objects of the AceTypeSystem
      void addSourceFileInformation​(org.w3c.dom.Document domDocument, org.apache.uima.jcas.JCas jcas)
      This method is used to put the source file information of the XML file into the proper object of the AceTypeSystem.
      void addTimex2Information​(org.w3c.dom.Node timex2Node, de.julielab.jcore.types.ace.Timex2 aceTimex2, org.apache.uima.jcas.JCas jcas)
      This method is used to put the timex2 information from the XML file into proper objects of the AceTypeSystem
      void addValueInformation​(org.w3c.dom.Node valueNode, de.julielab.jcore.types.ace.Value aceValue, org.apache.uima.jcas.JCas jcas)
      This method is used to put the value information from the XML file into proper objects of the AceTypeSystem
      void close()  
      void generateJulesTypes​(org.apache.uima.jcas.JCas jcas)  
      org.apache.uima.jcas.cas.FSArray getDocumentFSArray​(org.w3c.dom.Node sourceFileNode, org.apache.uima.jcas.JCas jcas)
      This method is used to build an FSArray which will contain instances of ace.Documents
      org.apache.uima.jcas.cas.FSArray getEntityAttributesFSArray​(org.w3c.dom.Node entityNode, org.apache.uima.jcas.JCas jcas)
      This method is used to build an FSArray which will contain entity attributes
      org.apache.uima.jcas.cas.FSArray getEntityFSArray​(org.w3c.dom.Node documentNode, org.apache.uima.jcas.JCas jcas)
      This method is used to build the FSArray which will contain aceEntities
      org.apache.uima.jcas.cas.FSArray getEntityMentionFSArray​(org.w3c.dom.Node entityNode, de.julielab.jcore.types.ace.Entity aceEntity, org.apache.uima.jcas.JCas jcas)
      This method is used to get an FSArray of entityMentions of a specific XML node
      org.apache.uima.jcas.cas.FSArray getEventArgumentFSArray​(org.w3c.dom.Node eventNode, org.apache.uima.jcas.JCas jcas)
      This method is used to get an FSArray of eventArguments of a specific XML node
      org.apache.uima.jcas.cas.FSArray getEventFSArray​(org.w3c.dom.Node documentNode, org.apache.uima.jcas.JCas jcas)
      This method is used to build the FSArray which will contain aceEvents
      org.apache.uima.jcas.cas.FSArray getEventMentionArgumentFSArray​(org.w3c.dom.Node eventMentionNode, org.apache.uima.jcas.JCas jcas)
      This method is used to get an FSArray of eventMentionArguments of a specific XML node
      org.apache.uima.jcas.cas.FSArray getEventMentionFSArray​(org.w3c.dom.Node eventNode, de.julielab.jcore.types.ace.Event aceEvent, org.apache.uima.jcas.JCas jcas)
      This method is used to get an FSArray of eventMentions of a specific XML node
      void getHeadInformation​(de.julielab.jcore.types.ace.Head entityMentionHead, org.w3c.dom.Node entityMentionNode)
      This method is used to get the information about the head of an entity mention
      void getNext​(org.apache.uima.cas.CAS cas)  
      org.apache.uima.util.Progress[] getProgress()  
      org.apache.uima.jcas.cas.FSArray getRelationArgumentFSArray​(org.w3c.dom.Node relationNode, org.apache.uima.jcas.JCas jcas)
      This method is used to get an FSArray of RelationArguments of a specific XML node
      org.apache.uima.jcas.cas.FSArray getRelationFSArray​(org.w3c.dom.Node documentNode, org.apache.uima.jcas.JCas jcas)
      This method is used to build the FSArray which will contain aceValues
      org.apache.uima.jcas.cas.FSArray getRelationMentionArgumentFSArray​(org.w3c.dom.Node relationMentionNode, org.apache.uima.jcas.JCas jcas)
      This method is used to get an FSArray of RelationMentionArguments of a specific XML node
      org.apache.uima.jcas.cas.FSArray getRelationMentionFSArray​(org.w3c.dom.Node relationNode, de.julielab.jcore.types.ace.Relation aceRelation, org.apache.uima.jcas.JCas jcas)
      This method is used to get an FSArray of RelationMentions of a specific XML node
      java.lang.String getSgmFileName​(java.lang.String apfXmlFileName)
      This method turns a file name with the apf.xml extension into a file name with the sgm extension
      java.util.ArrayList<org.w3c.dom.Node> getSpecificNodeArrayList​(org.w3c.dom.NodeList children, java.lang.String elementName)
      This method is used to retrieve from a NodeList the nodes with a specific name.
      org.apache.uima.jcas.cas.FSArray getTimex2FSArray​(org.w3c.dom.Node documentNode, org.apache.uima.jcas.JCas jcas)
      This method is used to build the FSArray which will contain aceValues
      org.apache.uima.jcas.cas.FSArray getTimex2MentionFSArray​(org.w3c.dom.Node timex2Node, org.apache.uima.jcas.JCas jcas)
      This method is used to get an FSArray of timex2Mentions of a specific XML node
      org.apache.uima.jcas.cas.FSArray getValueFSArray​(org.w3c.dom.Node documentNode, org.apache.uima.jcas.JCas jcas)
      This method is used to build the FSArray which will contain aceValues
      org.apache.uima.jcas.cas.FSArray getValueMentionFSArray​(org.w3c.dom.Node valueNode, org.apache.uima.jcas.JCas jcas)
      This method is used to get an FSArray of valueMentions of a specific XML node
      boolean hasNext()  
      void initialize()
      This method is used to initialize attributes which are needed for the processing of the XML files
      java.lang.String retrieveAttribute​(org.w3c.dom.Node node, java.lang.String attributeName)
      This method is used to retrieve a certain attribute value from an XML node
      int retrieveStartEndValue​(org.w3c.dom.Node node, java.lang.String itemName)
      This method is used to retrieve the value of either the start attribute or the end attribute of an XML node.
      void setDocumentText​(org.apache.uima.jcas.JCas jcas, org.w3c.dom.Document sgmDomDocument)
      This method is used to set the document text to the cas
      void setEntityAttributes​(de.julielab.jcore.types.ace.Entity aceEntity, org.w3c.dom.Node entityNode)
      This method is used to set the attributes for an aceEntity
      void setEntityAttributesInformation​(de.julielab.jcore.types.ace.EntityAttribute entityAttributes, org.w3c.dom.Node entityAttributesNode, org.apache.uima.jcas.JCas jcas)
      This method is used to set the attributes information of a particular instance of entityAttributes
      void setEntityMentionAttributes​(de.julielab.jcore.types.ace.EntityMention entityMention, org.w3c.dom.Node entityMentionNode)
      This method is used to set the attributes for an entityMention
      void setEntityMentionHead​(de.julielab.jcore.types.ace.EntityMention entityMention, org.w3c.dom.Node entityMentionNode, org.apache.uima.jcas.JCas jcas)
      This method is used to update the entity mention information by adding the entity mention head
      void setEntityMentionStartEnd​(de.julielab.jcore.types.ace.EntityMention entityMention, org.w3c.dom.Node entityMentionNode)
      This method is used to retrieve the start and the of an entity mention from an XML node
      void setEventArgumentAttributes​(de.julielab.jcore.types.ace.EventArgument eventArgument, org.w3c.dom.Node eventArgumentNode)
      This method is used to set the attributes for an eventArgument
      void setEventAttributes​(de.julielab.jcore.types.ace.Event aceEvent, org.w3c.dom.Node eventNode)
      This method is used to set the attributes for an aceRelation
      void setEventMentionAnchor​(de.julielab.jcore.types.ace.EventMention eventMention, org.w3c.dom.Node eventMentionNode, org.apache.uima.jcas.JCas jcas)
      This method is used to set the anchor for an eventMention
      void setEventMentionAnchorStartEnd​(de.julielab.jcore.types.ace.Anchor eventMentionAnchor, org.w3c.dom.Node anchorNode)
      This method is used to retrieve the start and the end of a value from an XML node and to set it to proper attributes of an ace type
      void setEventMentionArgumentAttributes​(de.julielab.jcore.types.ace.EventMentionArgument eventMentionArgument, org.w3c.dom.Node eventMentionArgumentNode)
      This method is used to set the attributes for an eventMentionArgument
      void setEventMentionArgumentStartEnd​(de.julielab.jcore.types.ace.EventMentionArgument eventMentionArgument, org.w3c.dom.Node eventMentionArgumentNode)
      This method is used to retrieve the start and the end of a value from an XML node and to set it to proper attributes of an ace type
      void setEventMentionAttributes​(de.julielab.jcore.types.ace.EventMention eventMention, org.w3c.dom.Node eventMentionNode)
      This method is used to set the attributes for an eventMention
      void setEventMentionLDCScope​(de.julielab.jcore.types.ace.EventMention eventMention, org.w3c.dom.Node eventMentionNode, org.apache.uima.jcas.JCas jcas)
      This method is used to set the LDC scope for an eventMention
      void setEventMentionLDCScopeStartEnd​(de.julielab.jcore.types.ace.LDC_Scope eventMentionLDCScope, org.w3c.dom.Node LDCScopeNode)
      This method is used to retrieve the start and the end of a value from an XML node and to set it to proper attributes of an ace type
      void setEventMentiuonStartEnd​(de.julielab.jcore.types.ace.EventMention eventMention, org.w3c.dom.Node eventMentionNode)
      This method is used to retrieve the start and the end of a value from an XML node and to set it to proper attributes of an ace type
      void setJulesNameName​(de.julielab.jcore.types.ace.Name julesName, org.w3c.dom.Node nameNode)
      This method is used to safely set the name attribute for the jules.types.Name.
      void setJulesNameStartEnd​(de.julielab.jcore.types.ace.Name julesName, org.w3c.dom.Node nameNode)
      This method is used to retrieve the start and the end of a value from an XML node and to set it to proper attributes of an ace type
      void setRelationArgumentAttributes​(de.julielab.jcore.types.ace.RelationArgument relationArgument, org.w3c.dom.Node relationArgumentNode)
      This method is used to set the attributes for a relationArgument
      void setRelationAttributes​(de.julielab.jcore.types.ace.Relation aceRelation, org.w3c.dom.Node relationNode)
      This method is used to set the attributes for an aceRelation
      void setRelationMentionArgumentAttributes​(de.julielab.jcore.types.ace.RelationMentionArgument relationMentionArgument, org.w3c.dom.Node relationMentionArgumentNode)
      This method is used to set the attributes for a relationMentionArgument
      void setRelationMentionArgumentStartEnd​(de.julielab.jcore.types.ace.RelationMentionArgument relationMentionArgument, org.w3c.dom.Node relationMentionArgumentNode)
      This method is used to retrieve the start and the end of a value from an XML node and to set it to proper attributes of an ace type
      void setRelationMentionAttributes​(de.julielab.jcore.types.ace.RelationMention relationMention, org.w3c.dom.Node relationMentionNode)
      This method is used to set the attributes for a relationMention
      void setRelationMentionStartEnd​(de.julielab.jcore.types.ace.RelationMention relationMention, org.w3c.dom.Node relationMentionNode)
      This method is used to retrieve the start and the end of a value from an XML node and to set it to proper attributes of an ace type
      void setSourceFileAttributes​(de.julielab.jcore.types.ace.SourceFile aceSourceFile, org.w3c.dom.Node sourceFileNode)
      This method is used to set the attributes for a sourceFile
      void setTimex2Attributes​(de.julielab.jcore.types.ace.Timex2 aceTimex2, org.w3c.dom.Node timex2Node)
      This method is used to set the attributes for an aceTimex2
      void setTimex2MentionAttributes​(de.julielab.jcore.types.ace.Timex2Mention timex2Mention, org.w3c.dom.Node timex2MentionNode)  
      void setTimex2MentionStartEnd​(de.julielab.jcore.types.ace.Timex2Mention timex2Mention, org.w3c.dom.Node timex2MentionNode)
      This method is used to retrieve the start and the end of a value from an XML node and to set it to proper attributes of an ace type
      void setValueAttributes​(de.julielab.jcore.types.ace.Value aceValue, org.w3c.dom.Node valueNode)
      This method is used to set the attributes for an aceValue
      void setValueMentionAttributes​(de.julielab.jcore.types.ace.ValueMention valueMention, org.w3c.dom.Node valueMentionNode)
      This method is used to set the attributes for a valueMention
      void setValueMentionStartEnd​(de.julielab.jcore.types.ace.ValueMention valueMention, org.w3c.dom.Node valueMentionNode)
      This method is used to retrieve the start and the end of a value from an XML node and to set it to proper attributes of an ace type
      void writeFailureFile​(java.lang.String fileName)
      This method is used for debugging purposes only
      • Methods inherited from class org.apache.uima.collection.CollectionReader_ImplBase

        destroy, getCasInitializer, getProcessingResourceMetaData, initialize, isConsuming, reconfigure, setCasInitializer, typeSystemInit
      • Methods inherited from class org.apache.uima.resource.ConfigurableResource_ImplBase

        getConfigParameterValue, getConfigParameterValue, setConfigParameterValue, setConfigParameterValue
      • Methods inherited from class org.apache.uima.resource.Resource_ImplBase

        getCasManager, getLogger, getMetaData, getRelativePathResolver, getResourceManager, getUimaContext, getUimaContextAdmin, setLogger, setMetaData
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
      • Methods inherited from interface org.apache.uima.resource.ConfigurableResource

        getConfigParameterValue, getConfigParameterValue, setConfigParameterValue, setConfigParameterValue
      • Methods inherited from interface org.apache.uima.resource.Resource

        getLogger, getMetaData, getResourceManager, getUimaContext, getUimaContextAdmin, setLogger
    • Field Detail

      • GENERATE_JCORE_TYPES

        public static final java.lang.String GENERATE_JCORE_TYPES
        See Also:
        Constant Field Values
      • PARAM_INPUTDIR

        public static final java.lang.String PARAM_INPUTDIR
        Name of configuration parameter that must be set to the path of a directory containing input files.
        See Also:
        Constant Field Values
      • ELEMENT_ENTITY

        public static final java.lang.String ELEMENT_ENTITY
        XML element of content entity
        See Also:
        Constant Field Values
      • ELEMENT_DOCUMENT

        public static final java.lang.String ELEMENT_DOCUMENT
        XML element of content document
        See Also:
        Constant Field Values
      • ELEMENT_ENTITY_MENTION

        public static final java.lang.String ELEMENT_ENTITY_MENTION
        XML element of content entity_mention
        See Also:
        Constant Field Values
      • ELEMENT_SOURCE_FILE

        public static final java.lang.String ELEMENT_SOURCE_FILE
        XML element of content source_file
        See Also:
        Constant Field Values
      • ELEMENT_EXTENT

        public static final java.lang.String ELEMENT_EXTENT
        XML element of content extent
        See Also:
        Constant Field Values
      • ELEMENT_HEAD

        public static final java.lang.String ELEMENT_HEAD
        XML element of content head
        See Also:
        Constant Field Values
      • ELEMENT_CHARSEQ

        public static final java.lang.String ELEMENT_CHARSEQ
        XML element of content charseq
        See Also:
        Constant Field Values
      • ELEMENT_ENTITY_ATTRIBUTES

        public static final java.lang.String ELEMENT_ENTITY_ATTRIBUTES
        XML element of content entity_attributes
        See Also:
        Constant Field Values
      • ELEMENT_NAME

        public static final java.lang.String ELEMENT_NAME
        XML element of content name
        See Also:
        Constant Field Values
      • ELEMENT_VALUE

        public static final java.lang.String ELEMENT_VALUE
        XML element of content value
        See Also:
        Constant Field Values
      • ELEMENT_TIMEX2

        public static final java.lang.String ELEMENT_TIMEX2
        XML element of content timex2
        See Also:
        Constant Field Values
      • ELEMENT_VALUE_MENTION

        public static final java.lang.String ELEMENT_VALUE_MENTION
        XML element of content value_mention
        See Also:
        Constant Field Values
      • ELEMENT_ANCHOR

        public static final java.lang.String ELEMENT_ANCHOR
        XML element of content anchor
        See Also:
        Constant Field Values
      • ELEMENT_LDC_SCOPE

        public static final java.lang.String ELEMENT_LDC_SCOPE
        XML element of content ldc_scope
        See Also:
        Constant Field Values
      • ELEMENT_TIMEX2_MENTION

        public static final java.lang.String ELEMENT_TIMEX2_MENTION
        XML element of content timex2_mention
        See Also:
        Constant Field Values
      • ELEMENT_RELATION

        public static final java.lang.String ELEMENT_RELATION
        XML element of content relation
        See Also:
        Constant Field Values
      • ELEMENT_EVENT

        public static final java.lang.String ELEMENT_EVENT
        XML element of content event
        See Also:
        Constant Field Values
      • ELEMENT_RELATION_ARGUMENT

        public static final java.lang.String ELEMENT_RELATION_ARGUMENT
        XML element of content relation_argument
        See Also:
        Constant Field Values
      • ELEMENT_EVENT_ARGUMENT

        public static final java.lang.String ELEMENT_EVENT_ARGUMENT
        XML element of content event_argument
        See Also:
        Constant Field Values
      • ELEMENT_EVENT_MENTION

        public static final java.lang.String ELEMENT_EVENT_MENTION
        XML element of content event_mention
        See Also:
        Constant Field Values
      • ELEMENT_RELATION_MENTION

        public static final java.lang.String ELEMENT_RELATION_MENTION
        XML element of content relation_mention
        See Also:
        Constant Field Values
      • ELEMENT_RELATION_MENTION_ARGUMENT

        public static final java.lang.String ELEMENT_RELATION_MENTION_ARGUMENT
        XML element of content relation_mention_argument
        See Also:
        Constant Field Values
      • ELEMENT_EVENT_MENTION_ARGUMENT

        public static final java.lang.String ELEMENT_EVENT_MENTION_ARGUMENT
        XML element of content event_mention_argument
        See Also:
        Constant Field Values
      • ELEMENT_BODY

        public static final java.lang.String ELEMENT_BODY
        XML element of content BODY
        See Also:
        Constant Field Values
      • ELEMENT_TEXT

        public static final java.lang.String ELEMENT_TEXT
        XML element of content TEXT
        See Also:
        Constant Field Values
      • ITEM_START

        public static final java.lang.String ITEM_START
        XML item of content START
        See Also:
        Constant Field Values
      • ITEM_END

        public static final java.lang.String ITEM_END
        XML item of content END
        See Also:
        Constant Field Values
      • ITEM_ID

        public static final java.lang.String ITEM_ID
        XML item of content ID
        See Also:
        Constant Field Values
      • ITEM_MOD

        public static final java.lang.String ITEM_MOD
        XML item of content MOD
        See Also:
        Constant Field Values
      • ITEM_COMMENT

        public static final java.lang.String ITEM_COMMENT
        XML item of content COMMENT
        See Also:
        Constant Field Values
      • ITEM_ANCHOR_VAL

        public static final java.lang.String ITEM_ANCHOR_VAL
        XML item of content ANCHOR_VAL
        See Also:
        Constant Field Values
      • ITEM_VAL

        public static final java.lang.String ITEM_VAL
        XML item of content VAL
        See Also:
        Constant Field Values
      • ITEM_SET

        public static final java.lang.String ITEM_SET
        XML item of content SET
        See Also:
        Constant Field Values
      • ITEM_NON_SPECIFIC

        public static final java.lang.String ITEM_NON_SPECIFIC
        XML item of content NON_SPECIFIC
        See Also:
        Constant Field Values
      • ITEM_ANCHOR_DIR

        public static final java.lang.String ITEM_ANCHOR_DIR
        XML item of content ANCHOR_DIR
        See Also:
        Constant Field Values
      • ITEM_LEVEL

        public static final java.lang.String ITEM_LEVEL
        XML item of content LEVEL
        See Also:
        Constant Field Values
      • ITEM_TYPE

        public static final java.lang.String ITEM_TYPE
        XML item of content TYPE
        See Also:
        Constant Field Values
      • ITEM_SOURCE

        public static final java.lang.String ITEM_SOURCE
        XML item of content SOURCE
        See Also:
        Constant Field Values
      • ITEM_AUTHOR

        public static final java.lang.String ITEM_AUTHOR
        XML item of content AUTHOR
        See Also:
        Constant Field Values
      • ITEM_ENCODING

        public static final java.lang.String ITEM_ENCODING
        XML item of content ENCODING
        See Also:
        Constant Field Values
      • ITEM_SUBTYPE

        public static final java.lang.String ITEM_SUBTYPE
        XML item of content SUBTYPE
        See Also:
        Constant Field Values
      • ITEM_LDCTYPE

        public static final java.lang.String ITEM_LDCTYPE
        XML item of content LDCTYPE
        See Also:
        Constant Field Values
      • ITEM_LDCATR

        public static final java.lang.String ITEM_LDCATR
        XML item of content LDCATR
        See Also:
        Constant Field Values
      • ITEM_METONYMY_MENTION

        public static final java.lang.String ITEM_METONYMY_MENTION
        XML item of content METONYMY_MENTION
        See Also:
        Constant Field Values
      • ITEM_TENSE

        public static final java.lang.String ITEM_TENSE
        XML item of content TENSE
        See Also:
        Constant Field Values
      • ITEM_MODALITY

        public static final java.lang.String ITEM_MODALITY
        XML item of content MODALITY
        See Also:
        Constant Field Values
      • ITEM_POLARITY

        public static final java.lang.String ITEM_POLARITY
        XML item of content POLARITY
        See Also:
        Constant Field Values
      • ITEM_GENERICITY

        public static final java.lang.String ITEM_GENERICITY
        XML item of content GENERICITY
        See Also:
        Constant Field Values
      • ITEM_CLASS

        public static final java.lang.String ITEM_CLASS
        XML item of content CLASS
        See Also:
        Constant Field Values
      • ITEM_REFID

        public static final java.lang.String ITEM_REFID
        XML item of content REFID
        See Also:
        Constant Field Values
      • ITEM_ROLE

        public static final java.lang.String ITEM_ROLE
        XML item of content ROLE
        See Also:
        Constant Field Values
      • ITEM_URI

        public static final java.lang.String ITEM_URI
        XML item of content URI
        See Also:
        Constant Field Values
      • ITEM_DOCID

        public static final java.lang.String ITEM_DOCID
        XML item of content DOCID
        See Also:
        Constant Field Values
      • ITEM_LEXICALCONDITION

        public static final java.lang.String ITEM_LEXICALCONDITION
        XML item of content LEXICALCONDITION
        See Also:
        Constant Field Values
    • Constructor Detail

      • AceReader

        public AceReader()
    • Method Detail

      • getNext

        public void getNext​(org.apache.uima.cas.CAS cas)
                     throws java.io.IOException,
                            org.apache.uima.collection.CollectionException
        Throws:
        java.io.IOException
        org.apache.uima.collection.CollectionException
        See Also:
        CollectionReader.getNext(org.apache.uima.cas.CAS)
      • generateJulesTypes

        public void generateJulesTypes​(org.apache.uima.jcas.JCas jcas)
                                throws java.lang.SecurityException,
                                       java.lang.IllegalArgumentException,
                                       java.lang.ClassNotFoundException,
                                       java.lang.NoSuchMethodException,
                                       java.lang.InstantiationException,
                                       java.lang.IllegalAccessException,
                                       java.lang.reflect.InvocationTargetException
        Parameters:
        jcas -
        Throws:
        java.lang.SecurityException
        java.lang.IllegalArgumentException
        java.lang.ClassNotFoundException
        java.lang.NoSuchMethodException
        java.lang.InstantiationException
        java.lang.IllegalAccessException
        java.lang.reflect.InvocationTargetException
      • writeFailureFile

        public void writeFailureFile​(java.lang.String fileName)
        This method is used for debugging purposes only
        Parameters:
        fileName - String which specifies the destination file for the failure information
      • setDocumentText

        public void setDocumentText​(org.apache.uima.jcas.JCas jcas,
                                    org.w3c.dom.Document sgmDomDocument)
        This method is used to set the document text to the cas
        Parameters:
        jcas - JCas which will be updated by adding the document text
        sgmDomDocument - Document which will be parsed in order to retrieve the document text
      • getSgmFileName

        public java.lang.String getSgmFileName​(java.lang.String apfXmlFileName)
        This method turns a file name with the apf.xml extension into a file name with the sgm extension
        Parameters:
        apfXmlFileName - String which specifies a file with the apf.xml extension
        Returns:
        sgmFileName String which contains the file name with the smg extension
      • addTimex2Information

        public void addTimex2Information​(org.w3c.dom.Node timex2Node,
                                         de.julielab.jcore.types.ace.Timex2 aceTimex2,
                                         org.apache.uima.jcas.JCas jcas)
        This method is used to put the timex2 information from the XML file into proper objects of the AceTypeSystem
        Parameters:
        timex2Node - Node which will be parsed in order to retrieve timex2 information
        aceTimex2 - ace.Timex2 which will be updated by adding its attribute values
        jcas - Jcas which will be filled with retrieved information
      • addRelationInformation

        public void addRelationInformation​(org.w3c.dom.Node relationNode,
                                           de.julielab.jcore.types.ace.Relation aceRelation,
                                           org.apache.uima.jcas.JCas jcas)
        This method is used to put the relation information from the XML file into proper objects of the AceTypeSystem
        Parameters:
        relationNode - Node which will be parsed in order to retrieve relation information
        aceRelation - ace.Relation which will be updated by adding its attribute values
        jcas - Jcas which will be filled with retrieved information
      • addEventInformation

        public void addEventInformation​(org.w3c.dom.Node eventNode,
                                        de.julielab.jcore.types.ace.Event aceEvent,
                                        org.apache.uima.jcas.JCas jcas)
        This method is used to put the event information from the XML file into proper objects of the AceTypeSystem
        Parameters:
        eventNode - Node which will be parsed in order to retrieve relation information
        aceEvent - ace.Event which will be updated by adding its attribute values
        jcas - Jcas which will be filled with retrieved information
      • retrieveAttribute

        public java.lang.String retrieveAttribute​(org.w3c.dom.Node node,
                                                  java.lang.String attributeName)
        This method is used to retrieve a certain attribute value from an XML node
        Parameters:
        node - Node which specified attribute will be parsed in order to retrieve its value
        attributeName - String which specifies the name of the attribute which value is to be retrieved
        Returns:
        attributeValue String which contains the retrieved attribute value
      • addValueInformation

        public void addValueInformation​(org.w3c.dom.Node valueNode,
                                        de.julielab.jcore.types.ace.Value aceValue,
                                        org.apache.uima.jcas.JCas jcas)
        This method is used to put the value information from the XML file into proper objects of the AceTypeSystem
        Parameters:
        valueNode - Node which will be parsed in order to retrieve value information
        aceValue - ace.Value which will be updated by adding its attribute values
        jcas - Jcas which will be filled with retrieved information
      • addEntityInformation

        public void addEntityInformation​(org.w3c.dom.Node entityNode,
                                         de.julielab.jcore.types.ace.Entity aceEntity,
                                         org.apache.uima.jcas.JCas jcas)
        This method is used to put the entities from the XML file into proper objects of the AceTypeSystem
        Parameters:
        entityNode - Node which will be parsed in order to retrieve valuable information
        aceEntity - ace.Entity which will be updated by adding its attribute values
        jcas - Jcas which will be filled with retrieved information
      • getEntityAttributesFSArray

        public org.apache.uima.jcas.cas.FSArray getEntityAttributesFSArray​(org.w3c.dom.Node entityNode,
                                                                           org.apache.uima.jcas.JCas jcas)
        This method is used to build an FSArray which will contain entity attributes
        Parameters:
        entityNode - Node which will be parsed in order to retrieve the entity attributes information
        jcas - JCas which will be filled with retrieved information
      • setEntityAttributesInformation

        public void setEntityAttributesInformation​(de.julielab.jcore.types.ace.EntityAttribute entityAttributes,
                                                   org.w3c.dom.Node entityAttributesNode,
                                                   org.apache.uima.jcas.JCas jcas)
        This method is used to set the attributes information of a particular instance of entityAttributes
        Parameters:
        entityAttributes - ace.EntityAttributes which will be updated by adding of certain entity attributes information
        entityAttributesNode - Node which will be parsed in order to retrieve entity attributes information
        jcas - JCAs which will be filled with retrieved information
      • setJulesNameStartEnd

        public void setJulesNameStartEnd​(de.julielab.jcore.types.ace.Name julesName,
                                         org.w3c.dom.Node nameNode)
        This method is used to retrieve the start and the end of a value from an XML node and to set it to proper attributes of an ace type
        Parameters:
        julesName - jules.types.Name which will be updated by adding the start and end information
        nameNode - Node which contains the name start and end
      • setValueMentionStartEnd

        public void setValueMentionStartEnd​(de.julielab.jcore.types.ace.ValueMention valueMention,
                                            org.w3c.dom.Node valueMentionNode)
        This method is used to retrieve the start and the end of a value from an XML node and to set it to proper attributes of an ace type
        Parameters:
        valueMention - ValueMention which will be updated by adding the start and end information
        valueMentionNode - Node which contains start and end of the value
      • setRelationMentionStartEnd

        public void setRelationMentionStartEnd​(de.julielab.jcore.types.ace.RelationMention relationMention,
                                               org.w3c.dom.Node relationMentionNode)
        This method is used to retrieve the start and the end of a value from an XML node and to set it to proper attributes of an ace type
        Parameters:
        relationMention - ace.RelationMention which will be updated by adding the start and end information
        relationMentionNode - Node which contains start and end of the value
      • setRelationMentionArgumentStartEnd

        public void setRelationMentionArgumentStartEnd​(de.julielab.jcore.types.ace.RelationMentionArgument relationMentionArgument,
                                                       org.w3c.dom.Node relationMentionArgumentNode)
        This method is used to retrieve the start and the end of a value from an XML node and to set it to proper attributes of an ace type
        Parameters:
        relationMentionArgument - ace.RelationMentionArgument which will be updated by adding the start and end information
        relationMentionArgumentNode - Node which contains start and end of the value
      • setEventMentiuonStartEnd

        public void setEventMentiuonStartEnd​(de.julielab.jcore.types.ace.EventMention eventMention,
                                             org.w3c.dom.Node eventMentionNode)
        This method is used to retrieve the start and the end of a value from an XML node and to set it to proper attributes of an ace type
        Parameters:
        eventMention - ace.EventMention which will be updated by adding the start and end information
        eventMentionNode - Node which contains start and end of the value
      • setEventMentionArgumentStartEnd

        public void setEventMentionArgumentStartEnd​(de.julielab.jcore.types.ace.EventMentionArgument eventMentionArgument,
                                                    org.w3c.dom.Node eventMentionArgumentNode)
        This method is used to retrieve the start and the end of a value from an XML node and to set it to proper attributes of an ace type
        Parameters:
        eventMentionArgument - ace.EventMentionArgument which will be updated by adding the start and end information
        eventMentionArgumentNode - Node which contains start and end of the value
      • retrieveStartEndValue

        public int retrieveStartEndValue​(org.w3c.dom.Node node,
                                         java.lang.String itemName)
        This method is used to retrieve the value of either the start attribute or the end attribute of an XML node.
        Parameters:
        node - Node which will be parsed in order to retrieve the proper values
        itemName - String which specifies, which item of an XML node has to be retrieved
      • setTimex2MentionStartEnd

        public void setTimex2MentionStartEnd​(de.julielab.jcore.types.ace.Timex2Mention timex2Mention,
                                             org.w3c.dom.Node timex2MentionNode)
        This method is used to retrieve the start and the end of a value from an XML node and to set it to proper attributes of an ace type
        Parameters:
        timex2Mention - Timex2Mention which will be updated by adding the start and end information
        timex2MentionNode - Node which contains start and end of the value
      • setEventMentionAnchorStartEnd

        public void setEventMentionAnchorStartEnd​(de.julielab.jcore.types.ace.Anchor eventMentionAnchor,
                                                  org.w3c.dom.Node anchorNode)
        This method is used to retrieve the start and the end of a value from an XML node and to set it to proper attributes of an ace type
        Parameters:
        eventMentionAnchor - ace.Anchor which will be updated by adding the start and end information
        anchorNode - Node which contains start and end of the value
      • setEventMentionLDCScopeStartEnd

        public void setEventMentionLDCScopeStartEnd​(de.julielab.jcore.types.ace.LDC_Scope eventMentionLDCScope,
                                                    org.w3c.dom.Node LDCScopeNode)
        This method is used to retrieve the start and the end of a value from an XML node and to set it to proper attributes of an ace type
        Parameters:
        eventMentionLDCScope - ace.LDC_Scope which will be updated by adding the start and end information
        LDCScopeNode - Node which contains start and end of the value
      • setJulesNameName

        public void setJulesNameName​(de.julielab.jcore.types.ace.Name julesName,
                                     org.w3c.dom.Node nameNode)
        This method is used to safely set the name attribute for the jules.types.Name. In the unlikely case that some name node does not have a name, a try-catch-instruction will be used to provide proper exception handling.
        Parameters:
        julesName - jules.types.Name which attribute "name" will be updated
        nameNode - Node which attribute "NAME" will be parsed in order to retrieve its value
      • getEntityMentionFSArray

        public org.apache.uima.jcas.cas.FSArray getEntityMentionFSArray​(org.w3c.dom.Node entityNode,
                                                                        de.julielab.jcore.types.ace.Entity aceEntity,
                                                                        org.apache.uima.jcas.JCas jcas)
        This method is used to get an FSArray of entityMentions of a specific XML node
        Parameters:
        entityNode - Node which will be processed in order to extract the proper information to fill the FSArray
        jcas - JCas which will be filled with retrieved information
      • getTimex2MentionFSArray

        public org.apache.uima.jcas.cas.FSArray getTimex2MentionFSArray​(org.w3c.dom.Node timex2Node,
                                                                        org.apache.uima.jcas.JCas jcas)
        This method is used to get an FSArray of timex2Mentions of a specific XML node
        Parameters:
        timex2Node - Node which will be processed in order to extract the proper information to fill the FSArray
        jcas - JCas which will be filled with retrieved information
      • getRelationArgumentFSArray

        public org.apache.uima.jcas.cas.FSArray getRelationArgumentFSArray​(org.w3c.dom.Node relationNode,
                                                                           org.apache.uima.jcas.JCas jcas)
        This method is used to get an FSArray of RelationArguments of a specific XML node
        Parameters:
        relationNode - Node which will be processed in order to extract the proper information to fill the FSArray
        jcas - JCas which will be filled with retrieved information
      • getEventArgumentFSArray

        public org.apache.uima.jcas.cas.FSArray getEventArgumentFSArray​(org.w3c.dom.Node eventNode,
                                                                        org.apache.uima.jcas.JCas jcas)
        This method is used to get an FSArray of eventArguments of a specific XML node
        Parameters:
        eventNode - Node which will be processed in order to extract the proper information to fill the FSArray
        jcas - JCas which will be filled with retrieved information
      • getEventMentionFSArray

        public org.apache.uima.jcas.cas.FSArray getEventMentionFSArray​(org.w3c.dom.Node eventNode,
                                                                       de.julielab.jcore.types.ace.Event aceEvent,
                                                                       org.apache.uima.jcas.JCas jcas)
        This method is used to get an FSArray of eventMentions of a specific XML node
        Parameters:
        eventNode - Node which will be processed in order to extract the proper information to fill the FSArray
        jcas - JCas which will be filled with retrieved information
      • getRelationMentionFSArray

        public org.apache.uima.jcas.cas.FSArray getRelationMentionFSArray​(org.w3c.dom.Node relationNode,
                                                                          de.julielab.jcore.types.ace.Relation aceRelation,
                                                                          org.apache.uima.jcas.JCas jcas)
        This method is used to get an FSArray of RelationMentions of a specific XML node
        Parameters:
        relationNode - Node which will be processed in order to extract the proper information to fill the FSArray
        jcas - JCas which will be filled with retrieved information
        Returns:
        relationMentionFSArray FSarray which contains the relationMentions
      • getRelationMentionArgumentFSArray

        public org.apache.uima.jcas.cas.FSArray getRelationMentionArgumentFSArray​(org.w3c.dom.Node relationMentionNode,
                                                                                  org.apache.uima.jcas.JCas jcas)
        This method is used to get an FSArray of RelationMentionArguments of a specific XML node
        Parameters:
        relationMentionNode - Node which will be processed in order to extract the proper information to fill the FSArray
        jcas - JCas which will be filled with retrieved information
        relationMentionArgumentFSArray - FSArray which contains relationMentionArguments
      • getEventMentionArgumentFSArray

        public org.apache.uima.jcas.cas.FSArray getEventMentionArgumentFSArray​(org.w3c.dom.Node eventMentionNode,
                                                                               org.apache.uima.jcas.JCas jcas)
        This method is used to get an FSArray of eventMentionArguments of a specific XML node
        Parameters:
        eventMentionNode - Node which will be processed in order to extract the proper information to fill the FSArray
        jcas - JCas which will be filled with retrieved information
        eventMentionArgumentFSArray - FSArray which contains eventMentionArguments
      • setEntityAttributes

        public void setEntityAttributes​(de.julielab.jcore.types.ace.Entity aceEntity,
                                        org.w3c.dom.Node entityNode)
        This method is used to set the attributes for an aceEntity
        Parameters:
        aceEntity - ace.Entity which will be updated by adding the attributes information
        entityNode - Node which will be parsed in order to retrieve the attributes
      • setValueAttributes

        public void setValueAttributes​(de.julielab.jcore.types.ace.Value aceValue,
                                       org.w3c.dom.Node valueNode)
        This method is used to set the attributes for an aceValue
        Parameters:
        aceValue - ace.Value which will be updated by adding the attributes information
        valueNode - Node which will be parsed in order to retrieve the attributes
      • setRelationAttributes

        public void setRelationAttributes​(de.julielab.jcore.types.ace.Relation aceRelation,
                                          org.w3c.dom.Node relationNode)
        This method is used to set the attributes for an aceRelation
        Parameters:
        aceRelation - ace.Relation which will be updated by adding the attributes information
        relationNode - Node which will be parsed in order to retrieve the attributes
      • setEventAttributes

        public void setEventAttributes​(de.julielab.jcore.types.ace.Event aceEvent,
                                       org.w3c.dom.Node eventNode)
        This method is used to set the attributes for an aceRelation
        Parameters:
        aceEvent - ace.Event which will be updated by adding the attributes information
        eventNode - Node which will be parsed in order to retrieve the attributes
      • setTimex2Attributes

        public void setTimex2Attributes​(de.julielab.jcore.types.ace.Timex2 aceTimex2,
                                        org.w3c.dom.Node timex2Node)
        This method is used to set the attributes for an aceTimex2
        Parameters:
        aceTimex2 - ace.Timex2 which will be updated by adding the attributes information
        timex2Node - Node which will be parsed in order to retrieve the attributes
      • setTimex2MentionAttributes

        public void setTimex2MentionAttributes​(de.julielab.jcore.types.ace.Timex2Mention timex2Mention,
                                               org.w3c.dom.Node timex2MentionNode)
      • setRelationMentionArgumentAttributes

        public void setRelationMentionArgumentAttributes​(de.julielab.jcore.types.ace.RelationMentionArgument relationMentionArgument,
                                                         org.w3c.dom.Node relationMentionArgumentNode)
        This method is used to set the attributes for a relationMentionArgument
        Parameters:
        relationMentionArgument - ace.RelationMentionArgument which will be updated by adding the attributes information
        relationMentionArgumentNode - Node which will be parsed in order to retrieve the attributes
      • setEventMentionArgumentAttributes

        public void setEventMentionArgumentAttributes​(de.julielab.jcore.types.ace.EventMentionArgument eventMentionArgument,
                                                      org.w3c.dom.Node eventMentionArgumentNode)
        This method is used to set the attributes for an eventMentionArgument
        Parameters:
        eventMentionArgument - ace.EventMentionArgument which will be updated by adding the attributes information
        eventMentionArgumentNode - Node which will be parsed in order to retrieve the attributes
      • setSourceFileAttributes

        public void setSourceFileAttributes​(de.julielab.jcore.types.ace.SourceFile aceSourceFile,
                                            org.w3c.dom.Node sourceFileNode)
        This method is used to set the attributes for a sourceFile
        Parameters:
        sourceFile - ace.SourceFile which will be updated by adding the attributes information
        sourceFileNode - Node which will be parsed in order to retrieve the attributes
      • setEntityMentionAttributes

        public void setEntityMentionAttributes​(de.julielab.jcore.types.ace.EntityMention entityMention,
                                               org.w3c.dom.Node entityMentionNode)
        This method is used to set the attributes for an entityMention
        Parameters:
        entityMention - ace.EntityMention which will be updated by adding the attributes information
        entityMentionNode - Node which will be parsed in order to retrieve the attributes
      • setRelationArgumentAttributes

        public void setRelationArgumentAttributes​(de.julielab.jcore.types.ace.RelationArgument relationArgument,
                                                  org.w3c.dom.Node relationArgumentNode)
        This method is used to set the attributes for a relationArgument
        Parameters:
        relationArgument - ace.RelationArgument which will be updated by adding the attributes information
        relationArgumentNode - Node which will be parsed in order to retrieve the attributes
      • setEventArgumentAttributes

        public void setEventArgumentAttributes​(de.julielab.jcore.types.ace.EventArgument eventArgument,
                                               org.w3c.dom.Node eventArgumentNode)
        This method is used to set the attributes for an eventArgument
        Parameters:
        eventArgument - ace.EventArgument which will be updated by adding the attributes information
        eventArgumentNode - Node which will be parsed in order to retrieve the attributes
      • setEventMentionAttributes

        public void setEventMentionAttributes​(de.julielab.jcore.types.ace.EventMention eventMention,
                                              org.w3c.dom.Node eventMentionNode)
        This method is used to set the attributes for an eventMention
        Parameters:
        eventMention - ace.EventMention which will be updated by adding the attributes information
        eventMentionNode - Node which will be parsed in order to retrieve the attributes
      • setEventMentionAnchor

        public void setEventMentionAnchor​(de.julielab.jcore.types.ace.EventMention eventMention,
                                          org.w3c.dom.Node eventMentionNode,
                                          org.apache.uima.jcas.JCas jcas)
        This method is used to set the anchor for an eventMention
        Parameters:
        eventMention - ace.EventMention which will be updated by adding the anchor information
        eventMentionNode - Node which will be parsed in order to retrieve the anchor information
        jcas - JCas which will be filled with retrieved information
      • setEventMentionLDCScope

        public void setEventMentionLDCScope​(de.julielab.jcore.types.ace.EventMention eventMention,
                                            org.w3c.dom.Node eventMentionNode,
                                            org.apache.uima.jcas.JCas jcas)
        This method is used to set the LDC scope for an eventMention
        Parameters:
        eventMention - ace.EventMention which will be updated by adding the LDC scope information
        eventMentionNode - Node which will be parsed in order to retrieve the LDC scope information
        jcas - JCas which will be filled with retrieved information
      • setRelationMentionAttributes

        public void setRelationMentionAttributes​(de.julielab.jcore.types.ace.RelationMention relationMention,
                                                 org.w3c.dom.Node relationMentionNode)
        This method is used to set the attributes for a relationMention
        Parameters:
        relationMention - ace.RelationMention which will be updated by adding the attributes information
        relationMentionNode - Node which will be parsed in order to retrieve the attributes
      • setValueMentionAttributes

        public void setValueMentionAttributes​(de.julielab.jcore.types.ace.ValueMention valueMention,
                                              org.w3c.dom.Node valueMentionNode)
        This method is used to set the attributes for a valueMention
        Parameters:
        valueMention - ace.ValueMention which will be updated by adding the attributes information
        valueMentionNode - Node which will be parsed in order to retrieve the attributes
      • getValueMentionFSArray

        public org.apache.uima.jcas.cas.FSArray getValueMentionFSArray​(org.w3c.dom.Node valueNode,
                                                                       org.apache.uima.jcas.JCas jcas)
        This method is used to get an FSArray of valueMentions of a specific XML node
        Parameters:
        valueNode - Node which will be processed in order to extract the proper information to fill the FSArray
        jcas - JCas which will be filled with retrieved information
      • setEntityMentionHead

        public void setEntityMentionHead​(de.julielab.jcore.types.ace.EntityMention entityMention,
                                         org.w3c.dom.Node entityMentionNode,
                                         org.apache.uima.jcas.JCas jcas)
        This method is used to update the entity mention information by adding the entity mention head
        Parameters:
        entityMention - ace.EntityMention which head will be updated
        entityMentionNode - Node which will be parsed in order to retrieve the head information
        jcas - JCas which will be filled with retrieved information
      • setEntityMentionStartEnd

        public void setEntityMentionStartEnd​(de.julielab.jcore.types.ace.EntityMention entityMention,
                                             org.w3c.dom.Node entityMentionNode)
        This method is used to retrieve the start and the of an entity mention from an XML node
        Parameters:
        entityMention - jules.types.ace.EntityMention which will be updated by adding the start and end information
        entityMentionNode - Node which contains the entity mention start and end
      • getHeadInformation

        public void getHeadInformation​(de.julielab.jcore.types.ace.Head entityMentionHead,
                                       org.w3c.dom.Node entityMentionNode)
        This method is used to get the information about the head of an entity mention
        Parameters:
        entityMentionHead - the jules.types.ace.Head which will be returned after retrieving information from the XML file
        entityMentionNode - a Node which contain the head information
      • getSpecificNodeArrayList

        public java.util.ArrayList<org.w3c.dom.Node> getSpecificNodeArrayList​(org.w3c.dom.NodeList children,
                                                                              java.lang.String elementName)
        This method is used to retrieve from a NodeList the nodes with a specific name. Note that an ArrayList is returned, not a NodeList!
        Parameters:
        children - NodeList from which specific nodes will be retrieved
        elementName - String which specifies the name of the nodes which will be retrieved from the NodeList
        Returns:
        specificNodeArrayList ArrayList which contains retrieved nodes from the NodeList
      • addDocumentInformation

        public void addDocumentInformation​(org.w3c.dom.Node documentNode,
                                           de.julielab.jcore.types.ace.Document aceDocument,
                                           org.apache.uima.jcas.JCas jcas)
        This method is used to put the document information of the XML file into the proper object of the AceTypeSystem.
        Parameters:
        documentNode - Node which will be parsed in order to retrieve the document information
        aceDocument - ace.Document which will be updated by adding retrieved document information
        jcas - JCas which will be filled with retrieved information
      • getEntityFSArray

        public org.apache.uima.jcas.cas.FSArray getEntityFSArray​(org.w3c.dom.Node documentNode,
                                                                 org.apache.uima.jcas.JCas jcas)
        This method is used to build the FSArray which will contain aceEntities
        Parameters:
        documentNode - Node that will be parsed in order to retrieve entity information
        jcas - JCas which will be filled with retrieved information
      • getValueFSArray

        public org.apache.uima.jcas.cas.FSArray getValueFSArray​(org.w3c.dom.Node documentNode,
                                                                org.apache.uima.jcas.JCas jcas)
        This method is used to build the FSArray which will contain aceValues
        Parameters:
        documentNode - Node that will be parsed in order to retrieve value information
        jcas - JCas which will be filled with retrieved information
      • getTimex2FSArray

        public org.apache.uima.jcas.cas.FSArray getTimex2FSArray​(org.w3c.dom.Node documentNode,
                                                                 org.apache.uima.jcas.JCas jcas)
        This method is used to build the FSArray which will contain aceValues
        Parameters:
        documentNode - Node that will be parsed in order to retrieve value information
        jcas - JCas which will be filled with retrieved information
      • getRelationFSArray

        public org.apache.uima.jcas.cas.FSArray getRelationFSArray​(org.w3c.dom.Node documentNode,
                                                                   org.apache.uima.jcas.JCas jcas)
        This method is used to build the FSArray which will contain aceValues
        Parameters:
        documentNode - Node that will be parsed in order to retrieve value information
        jcas - JCas which will be filled with retrieved information
      • getEventFSArray

        public org.apache.uima.jcas.cas.FSArray getEventFSArray​(org.w3c.dom.Node documentNode,
                                                                org.apache.uima.jcas.JCas jcas)
        This method is used to build the FSArray which will contain aceEvents
        Parameters:
        documentNode - Node that will be parsed in order to retrieve value information
        jcas - JCas which will be filled with retrieved information
      • addSourceFileInformation

        public void addSourceFileInformation​(org.w3c.dom.Document domDocument,
                                             org.apache.uima.jcas.JCas jcas)
        This method is used to put the source file information of the XML file into the proper object of the AceTypeSystem.
        Parameters:
        domDocument - the Document which contains the parsed information from the XML file
        jcas - JCas which will be filled with retrieved information
      • getDocumentFSArray

        public org.apache.uima.jcas.cas.FSArray getDocumentFSArray​(org.w3c.dom.Node sourceFileNode,
                                                                   org.apache.uima.jcas.JCas jcas)
        This method is used to build an FSArray which will contain instances of ace.Documents
        Parameters:
        domDocument - Document which will be parsed in order to retrieve aceDocument information
        jcas - JCas which will be filled with retrieved information
      • initialize

        public void initialize()
        This method is used to initialize attributes which are needed for the processing of the XML files
        Overrides:
        initialize in class org.apache.uima.collection.CollectionReader_ImplBase
      • close

        public void close()
                   throws java.io.IOException
        Throws:
        java.io.IOException
      • getProgress

        public org.apache.uima.util.Progress[] getProgress()
      • hasNext

        public boolean hasNext()
                        throws java.io.IOException,
                               org.apache.uima.collection.CollectionException
        Throws:
        java.io.IOException
        org.apache.uima.collection.CollectionException
        See Also:
        BaseCollectionReader.hasNext()