HTMLTag (x-search-service 2.0.0-3.11.0-125552 API)

java.lang.Object
- gr.forth.ics.isl.xsearch.util.HTMLTag

```
public class HTMLTag
extends Object
```
Class for analyzing text with HTML/XML contents

Author:

Pavlos Fafalios (fafalios@ics.forth.gr, fafalios@csd.uoc.gr)

Constructor Summary

Constructors
Constructor and Description

HTMLTag(String theSourceCode)

HTMLTag(URL theUrl)

HTMLTag(URL theUrl, boolean xmlContent)

Constructors
Constructor and Description
`HTMLTag(String theSourceCode)`
`HTMLTag(URL theUrl)`
`HTMLTag(URL theUrl, boolean xmlContent)`

Method Summary

Methods
Modifier and Type	Method and Description
`static String`	`getContentAttribute(String attr, String tagContent)` Static function that returns the content of an attribute from the text of a tag
`String`	`getDataFromTagToTag(String tag1, String tag2)` Finds and returns the text that contains all the inner data between two tags.
`String`	`getDataFromTagToTag(String tag1, String tag2, int fromIndex)` Finds and returns the text that contains all the inner data between two tags.
`String`	`getFirstTag()` Finds and returns the name of the first tag (e.g.
`String`	`getFirstTag(int fromIndex)` Finds and returns the name of the first tag (e.g.
`String`	`getFirstTagContent(String theTag)` Finds and returns the text that contains all the attributes of the first retrieved tag.
`String`	`getFirstTagContent(String theTag, int fromIndex)` Finds and returns the text that contains all the attributes of the first retrieved tag.
`String`	`getFirstTagContentContains(String theTag, String containment)` Finds and returns the text that contains all the attributes of the first retrieved tag.
`String`	`getFirstTagContentContains(String theTag, String containment, int fromIndex)` Finds and returns the text that contains all the attributes of the first retrieved tag.
`String`	`getFirstTagData(String theTag)` Finds and returns the text that contains all the inner data of the first retrieved tag.
`String`	`getFirstTagData(String theTag, int fromIndex)` Finds and returns the text that contains all the inner data of the first retrieved tag.
`String`	`getFirstTagDataContains(String theTag, String containment)` Finds and returns the text that contains all the inner data of the first retrieved tag.
`String`	`getFirstTagDataContains(String theTag, String containment, int fromIndex)` Finds and returns the text that contains all the inner data of the first retrieved tag.
`String`	`getFirstTagDataContentEquals(String theTag, String containment)` Finds and returns the text that contains all the inner data of the first retrieved tag.
`String`	`getFirstTagDataContentEquals(String theTag, String containment, int fromIndex)` Finds and returns the text that contains all the inner data of the first retrieved tag.
`int`	`getFirstTagIndex(String theTag)` Finds and returns the position of the first occurrence of a tag
`int`	`getFirstTagIndex(String theTag, int fromIndex)` Finds and returns the position of the first occurrence of a tag
`int`	`getFirstTagIndexContains(String theTag, String containment)` Finds and returns the position of the first occurrence of a tag that contains a particular text in its attributes' text
`int`	`getFirstTagIndexContains(String theTag, String containment, int fromIndex)` Finds and returns the position of the first occurrence of a tag that contains a particular text in its attributes' text
`int`	`getFirstTagIndexContentEquals(String theTag, String containment)` Finds and returns the position of the first occurrence of a tag that its attributes' text is equal to a particular text
`int`	`getFirstTagIndexContentEquals(String theTag, String containment, int fromIndex)` Finds and returns the position of the first occurrence of a tag that its attributes' text is equal to a particular text
`static String`	`getHref(String tagA)` Static function that returns the content of the 'href' attribute from the text of an 'a' tag
`int`	`getNumOfTags(String theTag)` Finds the number of occurrences of a tag.
`int`	`getNumOfTags(String theTag, int fromIndex)` Finds the number of occurrences of a tag.
`int`	`getNumOfTags(String theTag, int fromIndex, int toIndex)` Finds the number of occurrences of a tag.
`String`	`getSourceCode()`
`URL`	`getUrl()`
`boolean`	`isError()`
`static String`	`readFile(String filepath)` Static function that reads a file path and returns the contents of the file.
`static String`	`removeTag(String tag, String text)` Static function that removes all occurrences of a particular tag (and its inner data) from a text.
`static String`	`removeTagButNoText(String tag, String text)` Static function that removes all occurrences of a particular tag (without its inner data) from a text.
`static String`	`removeTags(String text)` Static function that removes all the tags (without their inner data) from a text.
`static String`	`removeTagsNoTagB(String text)` Static function that removes all the tags (without their inner data) from a text, apart from "b" tags.
`void`	`setError(boolean error)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - HTMLTag
```
public HTMLTag(URL theUrl)
```
    Parameters:
    theUrl - The URL of the page that you want to analyze
  - HTMLTag
```
public HTMLTag(URL theUrl,
       boolean xmlContent)
```
    Parameters:
    theUrl - The URL of the page that you want to analyze
    xmlContent - True if the URL of the page that you want to analyze is an XML page
  - HTMLTag
```
public HTMLTag(String theSourceCode)
```
    Parameters:
    theSourceCode - A string that you want to analyze.
- Method Detail
  - getFirstTag
```
public String getFirstTag()
```
    Finds and returns the name of the first tag (e.g. "div")
    
    Returns:
    The name of the first tag (e.g. "div" or "span" or ...)
  - getFirstTag
```
public String getFirstTag(int fromIndex)
```
    Finds and returns the name of the first tag (e.g. "div")
    
    Parameters:
    fromIndex - Start searching from that position (value must be between 0 and contents' total length)
    
    Returns:
    The name of the first tag (e.g. "div" or "span" or ...)
  - getFirstTagIndex
```
public int getFirstTagIndex(String theTag)
```
    Finds and returns the position of the first occurrence of a tag
    
    Parameters:
    theTag - The name of the tag (e.g. "div")
    
    Returns:
    The position of the first occurrence of tag
  - getFirstTagIndex
```
public int getFirstTagIndex(String theTag,
                   int fromIndex)
```
    Finds and returns the position of the first occurrence of a tag
    
    Parameters:
    theTag - The name of the tag (e.g. "div")
    fromIndex - Start searching from that position (value must be between 0 and content's total length)
    
    Returns:
    The position of the first occurrence of tag
  - getFirstTagIndexContains
```
public int getFirstTagIndexContains(String theTag,
                           String containment)
```
    Finds and returns the position of the first occurrence of a tag that contains a particular text in its attributes' text
    
    Parameters:
    theTag - The name of the tag (e.g. "div")
    containment - The text that you want the tag to contain in its attributes' text
    
    Returns:
    The position of the first occurrence of the tag
  - getFirstTagIndexContains
```
public int getFirstTagIndexContains(String theTag,
                           String containment,
                           int fromIndex)
```
    Finds and returns the position of the first occurrence of a tag that contains a particular text in its attributes' text
    
    Parameters:
    theTag - The name of the tag (e.g. "div")
    containment - The text that you want the tag to contain in its attributes' text
    fromIndex - Start searching from that position (value must be between 0 and content's total length)
    
    Returns:
    The position of the first occurrence of the tag
  - getFirstTagIndexContentEquals
```
public int getFirstTagIndexContentEquals(String theTag,
                                String containment)
```
    Finds and returns the position of the first occurrence of a tag that its attributes' text is equal to a particular text
    
    Parameters:
    theTag - The name of the tag (e.g. "div")
    containment - The text that you want the tag's attributes text to be equal to
    
    Returns:
    The position of the first occurrence of the tag
  - getFirstTagIndexContentEquals
```
public int getFirstTagIndexContentEquals(String theTag,
                                String containment,
                                int fromIndex)
```
    Finds and returns the position of the first occurrence of a tag that its attributes' text is equal to a particular text
    
    Parameters:
    theTag - The name of the tag (e.g. "div")
    containment - The text that you want the tag's attributes text to be equal to
    fromIndex - Start searching from that position (value must be between 0 and content's total length)
    
    Returns:
    The position of the first occurrence of the tag
  - getFirstTagContent
```
public String getFirstTagContent(String theTag)
```
    Finds and returns the text that contains all the attributes of the first retrieved tag. For example, for the tag: this functions returns: target="_blank" title="hello" href="http://hello"
    
    Parameters:
    theTag - The name of the tag (e.g. "a")
    
    Returns:
    The text that contains all the attributes of the first retrieved tag
  - getFirstTagContent
```
public String getFirstTagContent(String theTag,
                        int fromIndex)
```
    Finds and returns the text that contains all the attributes of the first retrieved tag. For example, for the tag: this functions returns: target="_blank" title="hello" href="http://hello"
    
    Parameters:
    theTag - The name of the tag (e.g. "a")
    fromIndex - Start searching from that position (value must be between 0 and content's total length)
    
    Returns:
    The text that contains all the attributes of the first retrieved tag
  - getFirstTagContentContains
```
public String getFirstTagContentContains(String theTag,
                                String containment)
```
    Finds and returns the text that contains all the attributes of the first retrieved tag. For example, for the tag: this functions returns: target="_blank" title="hello" href="http://hello"
    
    Parameters:
    theTag - The name of the tag (e.g. "div")
    containment - The text that you want the tag to contain in its attributes' text
    
    Returns:
    he text that contains all the attributes of the first retrieved tag
  - getFirstTagContentContains
```
public String getFirstTagContentContains(String theTag,
                                String containment,
                                int fromIndex)
```
    Finds and returns the text that contains all the attributes of the first retrieved tag. For example, for the tag: this functions returns: target="_blank" title="hello" href="http://hello"
    
    Parameters:
    theTag - The name of the tag (e.g. "div")
    containment - The text that you want the tag to contain in its attributes' text
    fromIndex - Start searching from that position (value must be between 0 and content's total length)
    
    Returns:
    he text that contains all the attributes of the first retrieved tag
  - getFirstTagData
```
public String getFirstTagData(String theTag)
```
    Finds and returns the text that contains all the inner data of the first retrieved tag. For example, for the tag:
    hello
    this functions returns: hello
    
    Parameters:
    theTag - The name of the tag (e.g. "div")
    
    Returns:
    The text that contains all the inner data of the first retrieved tag
  - getFirstTagData
```
public String getFirstTagData(String theTag,
                     int fromIndex)
```
    Finds and returns the text that contains all the inner data of the first retrieved tag. For example, for the tag:
    hello
    this functions returns: hello
    
    Parameters:
    theTag - The name of the tag (e.g. "div")
    fromIndex - Start searching from that position (value must be between 0 and content's total length)
    
    Returns:
    The text that contains all the inner data of the first retrieved tag
  - getFirstTagDataContains
```
public String getFirstTagDataContains(String theTag,
                             String containment)
```
    Finds and returns the text that contains all the inner data of the first retrieved tag. For example, for the tag:
    hello
    this functions returns: hello
    
    Parameters:
    theTag - The name of the tag (e.g. "div")
    containment - The text that you want the tag to contain in its attributes' text
    
    Returns:
    The text that contains all the inner data of the first retrieved tag
  - getFirstTagDataContains
```
public String getFirstTagDataContains(String theTag,
                             String containment,
                             int fromIndex)
```
    Finds and returns the text that contains all the inner data of the first retrieved tag. For example, for the tag:
    hello
    this functions returns: hello
    
    Parameters:
    theTag - The name of the tag (e.g. "div")
    containment - The text that you want the tag to contain in its attributes' text
    fromIndex - Start searching from that position (value must be between 0 and content's total length)
    
    Returns:
    The text that contains all the inner data of the first retrieved tag
  - getFirstTagDataContentEquals
```
public String getFirstTagDataContentEquals(String theTag,
                                  String containment)
```
    Finds and returns the text that contains all the inner data of the first retrieved tag. For example, for the tag:
    hello
    this functions returns: hello
    
    Parameters:
    theTag - The name of the tag (e.g. "div")
    containment - The text that you want the tag's attributes text to be equal to
    
    Returns:
    The text that contains all the inner data of the first retrieved tag
  - getFirstTagDataContentEquals
```
public String getFirstTagDataContentEquals(String theTag,
                                  String containment,
                                  int fromIndex)
```
    Finds and returns the text that contains all the inner data of the first retrieved tag. For example, for the tag:
    hello
    this functions returns: hello
    
    Parameters:
    theTag - The name of the tag (e.g. "div")
    containment - The text that you want the tag's attributes text to be equal to
    fromIndex - Start searching from that position (value must be between 0 and content's total length)
    
    Returns:
    The text that contains all the inner data of the first retrieved tag
  - getNumOfTags
```
public int getNumOfTags(String theTag)
```
    Finds the number of occurrences of a tag.
    
    Parameters:
    theTag - The name of the tag (e.g. "div")
    
    Returns:
    The number of occurrences of a tag
  - getNumOfTags
```
public int getNumOfTags(String theTag,
               int fromIndex)
```
    Finds the number of occurrences of a tag.
    
    Parameters:
    theTag - The name of the tag (e.g. "div")
    fromIndex - Start searching from that position (value must be between 0 and content's total length)
    
    Returns:
    The number of occurrences of a tag
  - getNumOfTags
```
public int getNumOfTags(String theTag,
               int fromIndex,
               int toIndex)
```
    Finds the number of occurrences of a tag.
    
    Parameters:
    theTag - The name of the tag (e.g. "div")
    fromIndex - Start searching from that position (value must be between 0 and content's total length)
    toIndex - End searching at that position (value must be between @start and content's total length)
    
    Returns:
    The number of occurrences of a tag
  - getDataFromTagToTag
```
public String getDataFromTagToTag(String tag1,
                         String tag2)
```
    Finds and returns the text that contains all the inner data between two tags.
    
    Parameters:
    tag1 - tag1 The name of the first tag (e.g. "div")
    tag2 - The name of the last tag (e.g. "div")
    
    Returns:
    The text that contains all the inner data between two tags
  - getDataFromTagToTag
```
public String getDataFromTagToTag(String tag1,
                         String tag2,
                         int fromIndex)
```
    Finds and returns the text that contains all the inner data between two tags.
    
    Parameters:
    tag1 - The name of the first tag (e.g. "div")
    tag2 - The name of the last tag (e.g. "div")
    fromIndex - Start searching from that position (value must be between 0 and content's total length)
    
    Returns:
    The text that contains all the inner data between two tags
  - removeTags
```
public static String removeTags(String text)
```
    Static function that removes all the tags (without their inner data) from a text. For example for the text:
    hello nick
    this function will return: hello nick
    
    Parameters:
    text - The text from which you want to remove all tags
    
    Returns:
    The text without tags
  - removeTagButNoText
```
public static String removeTagButNoText(String tag,
                        String text)
```
    Static function that removes all occurrences of a particular tag (without its inner data) from a text. For example, in case we want to remove all 'b' tags, for the text:
    hello nick. How are you?
    this function will return:
    hello nick. How are you?
    And if we call again that function for the tag '/b', we will get:
    hello nick. How are you?
    
    Parameters:
    tag - The name of the tag (e.g. "div")
    text - The text from which you want to remove the particular tag
    
    Returns:
    The text without all occurrences of a particular tag
  - removeTag
```
public static String removeTag(String tag,
               String text)
```
    Static function that removes all occurrences of a particular tag (and its inner data) from a text. For example, in case we want to remove all 'b' tags, for the text:
    hello nick. How are you?
    this function will return:
    hello nick. How are you?
    And if we call again that function for the tag '/b', we will get:
    hello nick. How are you?
    
    Parameters:
    tag - The name of the tag (e.g. "div")
    text - The text from which you want to remove the particular tag
    
    Returns:
    The text without all occurrences of a particular tag
  - removeTagsNoTagB
```
public static String removeTagsNoTagB(String text)
```
    Static function that removes all the tags (without their inner data) from a text, apart from "b" tags. For example for the text:
    hello nick
    this function will return: hello nick
    
    Parameters:
    text - The text from which you want to remove all tags apart from "b" tags
    
    Returns:
    The text without all other tags
  - getHref
```
public static String getHref(String tagA)
```
    Static function that returns the content of the 'href' attribute from the text of an 'a' tag
    
    Parameters:
    The - text of the 'a' tag from which you want to get the 'href' attribute
    
    Returns:
    The content of the 'href' attribute
  - getContentAttribute
```
public static String getContentAttribute(String attr,
                         String tagContent)
```
    Static function that returns the content of an attribute from the text of a tag
    
    Parameters:
    attr - The attribute from which you want to get the content
    tagContent - The text of the tag from which you want to get the content of the attribute @attr
    
    Returns:
    The content of the attribute
  - readFile
```
public static String readFile(String filepath)
```
    Static function that reads a file path and returns the contents of the file.
    
    Parameters:
    filepath - The path of the file you want to read
    
    Returns:
    The contents of the file
  - getUrl
```
public URL getUrl()
```
    Returns:
    The URL of the current HTMLTag object
  - getSourceCode
```
public String getSourceCode()
```
    Returns:
    The contents of the current HTMLTag object
  - isError
```
public boolean isError()
```
    Returns:
    If an error has occurred to the current HTMLTag object
  - setError
```
public void setError(boolean error)
```
    Parameters:
    error - True if an error has occurred to the current HTMLTag object

Class HTMLTag

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

HTMLTag

HTMLTag

HTMLTag

Method Detail

getFirstTag

getFirstTag

getFirstTagIndex

getFirstTagIndex

getFirstTagIndexContains

getFirstTagIndexContains

getFirstTagIndexContentEquals

getFirstTagIndexContentEquals

getFirstTagContent

getFirstTagContent

getFirstTagContentContains

getFirstTagContentContains

getFirstTagData

getFirstTagData

getFirstTagDataContains

getFirstTagDataContains

getFirstTagDataContentEquals

getFirstTagDataContentEquals

getNumOfTags

getNumOfTags

getNumOfTags

getDataFromTagToTag

getDataFromTagToTag

removeTags

removeTagButNoText

removeTag

removeTagsNoTagB

getHref

getContentAttribute

readFile

getUrl

getSourceCode

isError

setError