Package Torello.HTML.NodeSearch
Class TextNodeGet
- java.lang.Object
-
- Torello.HTML.NodeSearch.TextNodeGet
-
public class TextNodeGet extends java.lang.Object
TextNodeGet 🠞
TextNode:
This implies thatTagNode
elements are ignored completely in this search, and instead, the "text" (a.k.a. 'page-content'), represented as instances ofTextNode
, are searched.
Get:
This implies that theTextNode's
, themselves, are returned by these methods - rather thanVector
-index pointers.
Retrieves HTML-Document Text from Vectorized-HTML, as instances ofTextNode
, using a search-criteria that may be specified withString-Predicate's
, Regular-Expressions, or aTextComparitor
.
Methods Available
Method Explanation first (...) This will retrieve the first TextNode
match found in the vectorized-page parameter'html'
.nth (...) This will retrieve the nth TextNode
match found in the vectorized-page parameter'html'
.last (...) This will retrieve the last TextNode
match found in the vectorized-page parameter'html'
.nthFromEnd (...) This will retrieve the nth-from-last TextNode
match found in the vectorized-page parameter'html'
.all (...) This will return a Vector<TextNode>
that contains everyTextNode
that matches the specified search-criteria found inside the vectorized-page parameter'html'
allExcept (...) This will return a Vector<TextNode>
that contains everyTextNode
that does not match the specified search-criteria found inside the vectorized-page parameter'html'
Method Parameters
Parameter Explanation Vector<? HTMLNode> html
This represents any vectorized HTML page, sub-page, or list of partial-elements. int nth
This represents the 'nth'
match of a comparisonfor-loop
. When the method-signature used includes the parameter'nth'
, the firstn-1
matches that are found - will be skipped, and the'nth'
match is, instead, returned.
EXCEPTIONS: AnNException
shall throw if the value of parameter'nth'
is zero, negative, or larger than the size of the input html-Vector
.int sPos, int ePos
When these parameters are present, only HTMLNode's
that are found between the specifiedVector
indices will be considered for matching with the search criteria.
NOTE: In every situation where the parametersint sPos, int ePos
are used, parameter'ePos'
will accept a negative value, but parameter'sPos'
will not. When'ePos'
is passed a negative-value, the internalLV
('Loop Variable Counter') will have itspublic final int end
field set to the length of the vectorized-html page that was passed. (html.size()
of parameterVector<HTMLNode> html
).
EXCEPTIONS: AnIndexOutOfBoundsException
will be thrown if:- If
sPos
is negative, or ifsPos
is greater-than or equal-to the size of the inputVector
- If
ePos
is zero, or greater than the size of the inputVector
. - If
sPos
is a larger integer thanePos
TextComparitor tc
WORKS WITH: This parameter utilizes / works-with parameter String... compareStr
to perform the requested comparisons. The comparisons are computed using theTextNode.str String
-field of aTextNode
.
When this parameter is present in the method-signature parameter-list, the decision of whether aTextNode
is to be included in the search result-set is defined by this parameter'sFunctionalInterface Predicate 'test'
method.TextComparitor
is a JavaBiPredicate<String, String[]>
which compares its firstString
-parameter against theString's
in its second.Pattern p
This parameter references Java's "Regular Expression" processing engine. If the method-signature includes the java.util.regex.Pattern
parameter, the search-loops will use the standard Regular-Expression pattern matching routine:p.asPredicate().test(text_node.str)
when deciding whichTextNode's
"match" this search-criteria.Predicate<String> p
When this parameter is present in the method-signature parameter-list, the decision of whether a TextNode
is to be included in the search result-set are made by the results of the JavaPredicate.test(String)
method.
Specifically:p.test(text_node.str)
String... compareStr
WORKS WITH: This parameter works in coordination with parameter TextComparitor tc
. This parameter supplies theString's
by which the comparisons of theTextNode.str
field are compared.Return Values:
TextNode
represents a matchedTextNode
from the html vectorized-page parameter'html'
- A return value of
null
implies no matches were found. Vector<TextNode>
- A vector ofTextNode
represent all matches from the vectorized-page parameter'html'
- A zero-length
Vector<TextNode>
means no matches were found on the page or sub-page. Empty Vectors are returned from any method where the possibility existed for multiple-matches being provided as a result-set.
Hi-Lited Source-Code:This File's Source Code:
- View Here: Torello/HTML/NodeSearch/TextNodeGet.java
- Open New Browser-Tab: Torello/HTML/NodeSearch/TextNodeGet.java
File Size: 8,845 Bytes Line Count: 134 '\n' Characters Found
Actual Search Loop Class:
- View Here: SearchLoops/TextNodes/TxNGet.java
- Open New Browser-Tab: SearchLoops/TextNodes/TxNGet.java
File Size: 1,820 Bytes Line Count: 70 '\n' Characters Found
Argument Checker Class:
- View Here: ARGCHECK.java
- Open New Browser-Tab: ARGCHECK.java
File Size: 17,862 Bytes Line Count: 425 '\n' Characters Found
Stateless Class:This class neither contains any program-state, nor can it be instantiated. The@StaticFunctional
Annotation may also be called 'The Spaghetti Report'.Static-Functional
classes are, essentially, C-Styled Files, without any constructors or non-static member fields. It is a concept very similar to the Java-Bean's@Stateless
Annotation.
- 1 Constructor(s), 1 declared private, zero-argument constructor
- 36 Method(s), 36 declared static
- 0 Field(s)
-
-
Method Summary
All Matches Modifier and Type Method static Vector<TextNode>
all(Vector<? extends HTMLNode> html, Predicate<String> p)
static Vector<TextNode>
all(Vector<? extends HTMLNode> html, Pattern p)
static Vector<TextNode>
all(Vector<? extends HTMLNode> html, TextComparitor tc, String... compareStr)
All Matches, Range Limited Modifier and Type Method static Vector<TextNode>
all(Vector<? extends HTMLNode> html, int sPos, int ePos, Predicate<String> p)
static Vector<TextNode>
all(Vector<? extends HTMLNode> html, int sPos, int ePos, Pattern p)
static Vector<TextNode>
all(Vector<? extends HTMLNode> html, int sPos, int ePos, TextComparitor tc, String... compareStr)
All Non-Matches Modifier and Type Method static Vector<TextNode>
allExcept(Vector<? extends HTMLNode> html, Predicate<String> p)
static Vector<TextNode>
allExcept(Vector<? extends HTMLNode> html, Pattern p)
static Vector<TextNode>
allExcept(Vector<? extends HTMLNode> html, TextComparitor tc, String... compareStr)
All Non-Matches, Range Limited Modifier and Type Method static Vector<TextNode>
allExcept(Vector<? extends HTMLNode> html, int sPos, int ePos, Predicate<String> p)
static Vector<TextNode>
allExcept(Vector<? extends HTMLNode> html, int sPos, int ePos, Pattern p)
static Vector<TextNode>
allExcept(Vector<? extends HTMLNode> html, int sPos, int ePos, TextComparitor tc, String... compareStr)
First Match Modifier and Type Method static TextNode
first(Vector<? extends HTMLNode> html, Predicate<String> p)
static TextNode
first(Vector<? extends HTMLNode> html, Pattern p)
static TextNode
first(Vector<? extends HTMLNode> html, TextComparitor tc, String... compareStr)
First Match, Range Limited Modifier and Type Method static TextNode
first(Vector<? extends HTMLNode> html, int sPos, int ePos, Predicate<String> p)
static TextNode
first(Vector<? extends HTMLNode> html, int sPos, int ePos, Pattern p)
static TextNode
first(Vector<? extends HTMLNode> html, int sPos, int ePos, TextComparitor tc, String... compareStr)
Last Match Modifier and Type Method static TextNode
last(Vector<? extends HTMLNode> html, Predicate<String> p)
static TextNode
last(Vector<? extends HTMLNode> html, Pattern p)
static TextNode
last(Vector<? extends HTMLNode> html, TextComparitor tc, String... compareStr)
Last Match, Range Limited Modifier and Type Method static TextNode
last(Vector<? extends HTMLNode> html, int sPos, int ePos, Predicate<String> p)
static TextNode
last(Vector<? extends HTMLNode> html, int sPos, int ePos, Pattern p)
static TextNode
last(Vector<? extends HTMLNode> html, int sPos, int ePos, TextComparitor tc, String... compareStr)
Nth Match Modifier and Type Method static TextNode
nth(Vector<? extends HTMLNode> html, int nth, Predicate<String> p)
static TextNode
nth(Vector<? extends HTMLNode> html, int nth, Pattern p)
static TextNode
nth(Vector<? extends HTMLNode> html, int nth, TextComparitor tc, String... compareStr)
Nth Match, Range Limited Modifier and Type Method static TextNode
nth(Vector<? extends HTMLNode> html, int nth, int sPos, int ePos, Predicate<String> p)
static TextNode
nth(Vector<? extends HTMLNode> html, int nth, int sPos, int ePos, Pattern p)
static TextNode
nth(Vector<? extends HTMLNode> html, int nth, int sPos, int ePos, TextComparitor tc, String... compareStr)
Nth Match From End Modifier and Type Method static TextNode
nthFromEnd(Vector<? extends HTMLNode> html, int nth, Predicate<String> p)
static TextNode
nthFromEnd(Vector<? extends HTMLNode> html, int nth, Pattern p)
static TextNode
nthFromEnd(Vector<? extends HTMLNode> html, int nth, TextComparitor tc, String... compareStr)
Nth Match From End, Range Limited Modifier and Type Method static TextNode
nthFromEnd(Vector<? extends HTMLNode> html, int nth, int sPos, int ePos, Predicate<String> p)
static TextNode
nthFromEnd(Vector<? extends HTMLNode> html, int nth, int sPos, int ePos, Pattern p)
static TextNode
nthFromEnd(Vector<? extends HTMLNode> html, int nth, int sPos, int ePos, TextComparitor tc, String... compareStr)
-