Interface HTMLSegment

    • Method Detail

      • getElementWithID

        HTMLElement getElementWithID​(java.lang.String id)
                              throws org.xml.sax.SAXException
        Returns the HTMLElement found in this segment with the specified ID.
        Throws:
        org.xml.sax.SAXException - thrown if there is an error parsing the segment.
      • getElementsWithName

        HTMLElement[] getElementsWithName​(java.lang.String name)
                                   throws org.xml.sax.SAXException
        Returns the HTMLElements found in this segment with the specified name.
        Throws:
        org.xml.sax.SAXException
      • getElementsWithAttribute

        HTMLElement[] getElementsWithAttribute​(java.lang.String name,
                                               java.lang.String value)
                                        throws org.xml.sax.SAXException
        Returns the HTMLElements found with the specified attribute value.
        Throws:
        org.xml.sax.SAXException
        Since:
        1.6
      • getElementNames

        java.lang.String[] getElementNames()
                                    throws org.xml.sax.SAXException
        Returns a list of HTML element names contained in this HTML section.
        Throws:
        org.xml.sax.SAXException
      • getForms

        WebForm[] getForms()
                    throws org.xml.sax.SAXException
        Returns the forms found in this HTML segment in the order in which they appear.
        Throws:
        org.xml.sax.SAXException - thrown if there is an error parsing the segment.
      • getFormWithID

        WebForm getFormWithID​(java.lang.String ID)
                       throws org.xml.sax.SAXException
        Returns the form found in this HTML segment with the specified ID.
        Throws:
        org.xml.sax.SAXException - thrown if there is an error parsing the segment.
      • getFormWithName

        WebForm getFormWithName​(java.lang.String name)
                         throws org.xml.sax.SAXException
        Returns the form found in this HTML segment with the specified name.
        Throws:
        org.xml.sax.SAXException - thrown if there is an error parsing the segment.
      • getFirstMatchingForm

        WebForm getFirstMatchingForm​(HTMLElementPredicate predicate,
                                     java.lang.Object value)
                              throws org.xml.sax.SAXException
        Returns the first form found in the page matching the specified criteria.
        Throws:
        org.xml.sax.SAXException - thrown if there is an error parsing the response.
      • getMatchingForms

        WebForm[] getMatchingForms​(HTMLElementPredicate predicate,
                                   java.lang.Object criteria)
                            throws org.xml.sax.SAXException
        Returns all forms found in the page matching the specified criteria.
        Throws:
        org.xml.sax.SAXException - thrown if there is an error parsing the response.
      • getLinks

        WebLink[] getLinks()
                    throws org.xml.sax.SAXException
        Returns the links found in this HTML segment in the order in which they appear.
        Throws:
        org.xml.sax.SAXException - thrown if there is an error parsing the segment.
      • getLinkWith

        WebLink getLinkWith​(java.lang.String text)
                     throws org.xml.sax.SAXException
        Returns the first link which contains the specified text.
        Throws:
        org.xml.sax.SAXException - thrown if there is an error parsing the segment.
      • getLinkWithImageText

        WebLink getLinkWithImageText​(java.lang.String text)
                              throws org.xml.sax.SAXException
        Returns the first link which contains an image with the specified text as its 'alt' attribute.
        Throws:
        org.xml.sax.SAXException - thrown if there is an error parsing the segment.
      • getFirstMatchingLink

        WebLink getFirstMatchingLink​(HTMLElementPredicate predicate,
                                     java.lang.Object value)
                              throws org.xml.sax.SAXException
        Returns the first link found in the page matching the specified criteria.
        Throws:
        org.xml.sax.SAXException - thrown if there is an error parsing the response.
      • getMatchingLinks

        WebLink[] getMatchingLinks​(HTMLElementPredicate predicate,
                                   java.lang.Object criteria)
                            throws org.xml.sax.SAXException
        Returns all links found in the page matching the specified criteria.
        Throws:
        org.xml.sax.SAXException - thrown if there is an error parsing the response.
      • getImages

        WebImage[] getImages()
                      throws org.xml.sax.SAXException
        Returns the images found in the page in the order in which they appear.
        Throws:
        org.xml.sax.SAXException - thrown if there is an error parsing the segment.
      • getImageWithName

        WebImage getImageWithName​(java.lang.String name)
                           throws org.xml.sax.SAXException
        Returns the image found in the page with the specified name.
        Throws:
        org.xml.sax.SAXException - thrown if there is an error parsing the segment.
      • getImageWithSource

        WebImage getImageWithSource​(java.lang.String source)
                             throws org.xml.sax.SAXException
        Returns the first image found in the page with the specified src attribute.
        Throws:
        org.xml.sax.SAXException - thrown if there is an error parsing the segment.
      • getImageWithAltText

        WebImage getImageWithAltText​(java.lang.String source)
                              throws org.xml.sax.SAXException
        Returns the first image found in the page with the specified alt attribute.
        Throws:
        org.xml.sax.SAXException - thrown if there is an error parsing the segment.
      • getApplets

        WebApplet[] getApplets()
                        throws org.xml.sax.SAXException
        Returns the applets found in the page in the order in which they appear.
        Throws:
        org.xml.sax.SAXException - thrown if there is an error parsing the segment.
      • getTextBlocks

        TextBlock[] getTextBlocks()
                           throws org.xml.sax.SAXException
        Returns the top-level block elements found in the page in the order in which they appear.
        Throws:
        org.xml.sax.SAXException - thrown if there is an error parsing the segment.
        Since:
        1.6
      • getTables

        WebTable[] getTables()
                      throws org.xml.sax.SAXException
        Returns the top-level tables found in this HTML segment in the order in which they appear.
        Throws:
        org.xml.sax.SAXException - thrown if there is an error parsing the segment.
      • getFirstMatchingTable

        WebTable getFirstMatchingTable​(HTMLElementPredicate predicate,
                                       java.lang.Object criteria)
                                throws org.xml.sax.SAXException
        Returns the first table in the response which matches the specified predicate and value. Will recurse into any nested tables, as needed.
        Returns:
        the selected table, or null if none is found
        Throws:
        org.xml.sax.SAXException
      • getMatchingTables

        WebTable[] getMatchingTables​(HTMLElementPredicate predicate,
                                     java.lang.Object criteria)
                              throws org.xml.sax.SAXException
        Returns all tables found in the page matching the specified criteria.
        Throws:
        org.xml.sax.SAXException - thrown if there is an error parsing the response.
      • getTableStartingWith

        WebTable getTableStartingWith​(java.lang.String text)
                               throws org.xml.sax.SAXException
        Returns the first table in this HTML segment which has the specified text as the full text of its first non-blank row and non-blank column. Will recurse into any nested tables, as needed.
        Returns:
        the selected table, or null if none is found
        Throws:
        org.xml.sax.SAXException - thrown if there is an error parsing the segment.
      • getTableStartingWithPrefix

        WebTable getTableStartingWithPrefix​(java.lang.String text)
                                     throws org.xml.sax.SAXException
        Returns the first table in this HTML segment which has the specified text as a prefix of the text in its first non-blank row and non-blank column. Will recurse into any nested tables, as needed.
        Returns:
        the selected table, or null if none is found
        Throws:
        org.xml.sax.SAXException - thrown if there is an error parsing the segment.
      • getTableWithSummary

        WebTable getTableWithSummary​(java.lang.String summary)
                              throws org.xml.sax.SAXException
        Returns the first table in this HTML segment which has the specified text as its summary attribute. Will recurse into any nested tables, as needed.
        Returns:
        the selected table, or null if none is found
        Throws:
        org.xml.sax.SAXException - thrown if there is an error parsing the segment.
      • getTableWithID

        WebTable getTableWithID​(java.lang.String ID)
                         throws org.xml.sax.SAXException
        Returns the first table in this HTML segment which has the specified text as its ID attribute. Will recurse into any nested tables, as needed.
        Returns:
        the selected table, or null if none is found
        Throws:
        org.xml.sax.SAXException - thrown if there is an error parsing the segment.