org.apache.taglibs.scrape
Class ScrapeTag

java.lang.Object
  javax.servlet.jsp.tagext.TagSupport
      org.apache.taglibs.scrape.ScrapeTag

All Implemented Interfaces:

java.io.Serializable, javax.servlet.jsp.tagext.IterationTag, javax.servlet.jsp.tagext.Tag

public class ScrapeTag
extends javax.servlet.jsp.tagext.TagSupport

ScrapeTag - JSP tag scrape is used for setting the begin and end anchors of a scrape to be preformed by the parent tag of this tag, PageTag.

JSP Tag Lib Descriptor

 <name>scrape</name>
 <tagclass>org.apache.taglibs.scrape.ScrapeTag</tagclass>
 <bodycontent>empty</bodycontent>
 <info>
     Does the scraping of the page named in the parent page tag
 </info>

 <attribute>
          <name>id</name>
          <required>true</required>
          <rtexprval>false</rtexprval>
 </attribute>
 <attribute>
          <name>begin</name>
          <required>true</required>
          <rtexprval>false</rtexprval>
 </attribute>
 <attribute>
          <name>end</name>
          <required>true</required>
          <rtexprval>false</rtexprval>
 </attribute>
 <attribute>
          <name>strip</name>
          <required>false</required>
          <rtexprval>false</rtexprval>
 </attribute>
 <attribute>
          <name>anchors</name>
          <required>false</required>
          <rtexprval>false</rtexprval>
 </attribute>
 

Version:

1.0

Author:

Rich Catlett

See Also:

ScrapeData, Serialized Form

Field Summary

Fields inherited from class javax.servlet.jsp.tagext.TagSupport

id, pageContext

Fields inherited from interface javax.servlet.jsp.tagext.IterationTag

EVAL_BODY_AGAIN

Fields inherited from interface javax.servlet.jsp.tagext.Tag

EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE

Constructor Summary

ScrapeTag()

Method Summary

int	doEndTag() implementation of method from the Tag interface that tells the JSP what to do upon encountering the end tag for this tag
void	setAnchors(java.lang.String anchors) setter method for anchors
void	setBegin(java.lang.String begin) setter method for the beginning anchor for this scrape
void	setEnd(java.lang.String end) setter method for the ending anchor for this scrape
void	setStrip(java.lang.String strip) setter method for strip

Methods inherited from class javax.servlet.jsp.tagext.TagSupport

doAfterBody, doStartTag, findAncestorWithClass, getId, getParent, getValue, getValues, release, removeValue, setId, setPageContext, setParent, setValue

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ScrapeTag

public ScrapeTag()

Method Detail

doEndTag

public final int doEndTag()
                   throws javax.servlet.jsp.JspException

implementation of method from the Tag interface that tells the JSP what to do upon encountering the end tag for this tag

Specified by:

doEndTag in interface javax.servlet.jsp.tagext.Tag

Overrides:

doEndTag in class javax.servlet.jsp.tagext.TagSupport

Returns:

EVAL_PAGE int telling the tag handler that the rest of the jsp page is to be evaluated

Throws:

JSPException - thrown when error occurs in processing the body of this method

javax.servlet.jsp.JspException

setBegin

public final void setBegin(java.lang.String begin)

setter method for the beginning anchor for this scrape

Parameters:

begin - anchor for the beginning of this scrape

setEnd

public final void setEnd(java.lang.String end)

setter method for the ending anchor for this scrape

Parameters:

end - anchor for the end of this scrape

setAnchors

public final void setAnchors(java.lang.String anchors)

setter method for anchors

Parameters:

anchors - value to determine if anchors are included in result

setStrip

public final void setStrip(java.lang.String strip)

setter method for strip

Parameters:

strip - value determines if tags are to be removed from result