/usr/share/doc/libjenkins-dom4j-java/api/org/dom4j/rule/Pattern.html is in libjenkins-dom4j-java-doc 1.6.1-hudson-3-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.6.0_23) on Thu Oct 20 11:18:54 UTC 2011 -->
<TITLE>
Pattern (dom4j API)
</TITLE>
<META NAME="date" CONTENT="2011-10-20">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../javadoc.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Pattern (dom4j API)";
}
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<HR>
<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/Pattern.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../org/dom4j/rule/NullAction.html" title="class in org.dom4j.rule"><B>PREV CLASS</B></A>
<A HREF="../../../org/dom4j/rule/Rule.html" title="class in org.dom4j.rule"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../index.html?org/dom4j/rule/Pattern.html" target="_top"><B>FRAMES</B></A>
<A HREF="Pattern.html" target="_top"><B>NO FRAMES</B></A>
<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: <A HREF="#field_detail">FIELD</A> | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
org.dom4j.rule</FONT>
<BR>
Interface Pattern</H2>
<DL>
<DT><B>All Superinterfaces:</B> <DD><A HREF="../../../org/dom4j/NodeFilter.html" title="interface in org.dom4j">NodeFilter</A></DD>
</DL>
<HR>
<DL>
<DT><PRE>public interface <B>Pattern</B><DT>extends <A HREF="../../../org/dom4j/NodeFilter.html" title="interface in org.dom4j">NodeFilter</A></DL>
</PRE>
<P>
<p>
<code>Pattern</code> defines the behaviour for pattern in the XSLT
processing model.
</p>
<P>
<P>
<DL>
<DT><B>Version:</B></DT>
<DD>$Revision: 1.6 $</DD>
<DT><B>Author:</B></DT>
<DD><a href="mailto:james.strachan@metastuff.com">James Strachan </a></DD>
</DL>
<HR>
<P>
<!-- =========== FIELD SUMMARY =========== -->
<A NAME="field_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Field Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static short</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/dom4j/rule/Pattern.html#ANY_NODE">ANY_NODE</A></B></CODE>
<BR>
Matches any node</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static double</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/dom4j/rule/Pattern.html#DEFAULT_PRIORITY">DEFAULT_PRIORITY</A></B></CODE>
<BR>
According to the <a href="http://www.w3.org/TR/xslt11/#conflict">spec
</a> we should return 0.5 if we cannot determine the priority</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static short</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/dom4j/rule/Pattern.html#NONE">NONE</A></B></CODE>
<BR>
Matches no nodes</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE>static short</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/dom4j/rule/Pattern.html#NUMBER_OF_TYPES">NUMBER_OF_TYPES</A></B></CODE>
<BR>
Count of the number of node types</TD>
</TR>
</TABLE>
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Method Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> java.lang.String</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/dom4j/rule/Pattern.html#getMatchesNodeName()">getMatchesNodeName</A></B>()</CODE>
<BR>
For patterns which only match an ATTRIBUTE_NODE or an ELEMENT_NODE then
this pattern may return the name of the element or attribute it matches.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> short</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/dom4j/rule/Pattern.html#getMatchType()">getMatchType</A></B>()</CODE>
<BR>
DOCUMENT ME!</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> double</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/dom4j/rule/Pattern.html#getPriority()">getPriority</A></B>()</CODE>
<BR>
Returns the default resolution policy of the pattern according to the <a
href="http://www.w3.org/TR/xslt11/#conflict"> XSLT conflict resolution
spec </a>.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../org/dom4j/rule/Pattern.html" title="interface in org.dom4j.rule">Pattern</A>[]</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/dom4j/rule/Pattern.html#getUnionPatterns()">getUnionPatterns</A></B>()</CODE>
<BR>
If this pattern is a union pattern then this method should return an
array of patterns which describe the union pattern, which should contain
more than one pattern.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../org/dom4j/rule/Pattern.html#matches(org.dom4j.Node)">matches</A></B>(<A HREF="../../../org/dom4j/Node.html" title="interface in org.dom4j">Node</A> node)</CODE>
<BR>
DOCUMENT ME!</TD>
</TR>
</TABLE>
<P>
<!-- ============ FIELD DETAIL =========== -->
<A NAME="field_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Field Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="ANY_NODE"><!-- --></A><H3>
ANY_NODE</H3>
<PRE>
static final short <B>ANY_NODE</B></PRE>
<DL>
<DD>Matches any node
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#org.dom4j.rule.Pattern.ANY_NODE">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="NONE"><!-- --></A><H3>
NONE</H3>
<PRE>
static final short <B>NONE</B></PRE>
<DL>
<DD>Matches no nodes
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#org.dom4j.rule.Pattern.NONE">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="NUMBER_OF_TYPES"><!-- --></A><H3>
NUMBER_OF_TYPES</H3>
<PRE>
static final short <B>NUMBER_OF_TYPES</B></PRE>
<DL>
<DD>Count of the number of node types
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#org.dom4j.rule.Pattern.NUMBER_OF_TYPES">Constant Field Values</A></DL>
</DL>
<HR>
<A NAME="DEFAULT_PRIORITY"><!-- --></A><H3>
DEFAULT_PRIORITY</H3>
<PRE>
static final double <B>DEFAULT_PRIORITY</B></PRE>
<DL>
<DD>According to the <a href="http://www.w3.org/TR/xslt11/#conflict">spec
</a> we should return 0.5 if we cannot determine the priority
<P>
<DL>
<DT><B>See Also:</B><DD><A HREF="../../../constant-values.html#org.dom4j.rule.Pattern.DEFAULT_PRIORITY">Constant Field Values</A></DL>
</DL>
<!-- ============ METHOD DETAIL ========== -->
<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Method Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="matches(org.dom4j.Node)"><!-- --></A><H3>
matches</H3>
<PRE>
boolean <B>matches</B>(<A HREF="../../../org/dom4j/Node.html" title="interface in org.dom4j">Node</A> node)</PRE>
<DL>
<DD>DOCUMENT ME!
<P>
<DD><DL>
<DT><B>Specified by:</B><DD><CODE><A HREF="../../../org/dom4j/NodeFilter.html#matches(org.dom4j.Node)">matches</A></CODE> in interface <CODE><A HREF="../../../org/dom4j/NodeFilter.html" title="interface in org.dom4j">NodeFilter</A></CODE></DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>node</CODE> - DOCUMENT ME!
<DT><B>Returns:</B><DD>true if the pattern matches the given DOM4J node.</DL>
</DD>
</DL>
<HR>
<A NAME="getPriority()"><!-- --></A><H3>
getPriority</H3>
<PRE>
double <B>getPriority</B>()</PRE>
<DL>
<DD>Returns the default resolution policy of the pattern according to the <a
href="http://www.w3.org/TR/xslt11/#conflict"> XSLT conflict resolution
spec </a>.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>DOCUMENT ME!</DL>
</DD>
</DL>
<HR>
<A NAME="getUnionPatterns()"><!-- --></A><H3>
getUnionPatterns</H3>
<PRE>
<A HREF="../../../org/dom4j/rule/Pattern.html" title="interface in org.dom4j.rule">Pattern</A>[] <B>getUnionPatterns</B>()</PRE>
<DL>
<DD>If this pattern is a union pattern then this method should return an
array of patterns which describe the union pattern, which should contain
more than one pattern. Otherwise this method should return null.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>an array of the patterns which make up this union pattern or null
if this pattern is not a union pattern</DL>
</DD>
</DL>
<HR>
<A NAME="getMatchType()"><!-- --></A><H3>
getMatchType</H3>
<PRE>
short <B>getMatchType</B>()</PRE>
<DL>
<DD>DOCUMENT ME!
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>the type of node the pattern matches which by default should
return ANY_NODE if it can match any kind of node.</DL>
</DD>
</DL>
<HR>
<A NAME="getMatchesNodeName()"><!-- --></A><H3>
getMatchesNodeName</H3>
<PRE>
java.lang.String <B>getMatchesNodeName</B>()</PRE>
<DL>
<DD>For patterns which only match an ATTRIBUTE_NODE or an ELEMENT_NODE then
this pattern may return the name of the element or attribute it matches.
This allows a more efficient rule matching algorithm to be performed,
rather than a brute force approach of evaluating every pattern for a
given Node.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Returns:</B><DD>the name of the element or attribute this pattern matches or null
if this pattern matches any or more than one name.</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/Pattern.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../org/dom4j/rule/NullAction.html" title="class in org.dom4j.rule"><B>PREV CLASS</B></A>
<A HREF="../../../org/dom4j/rule/Rule.html" title="class in org.dom4j.rule"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../index.html?org/dom4j/rule/Pattern.html" target="_top"><B>FRAMES</B></A>
<A HREF="Pattern.html" target="_top"><B>NO FRAMES</B></A>
<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: <A HREF="#field_detail">FIELD</A> | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
Copyright ? 2005 MetaStuff Ltd. All Rights Reserved. Hosted by <p> <img src='http://sourceforge.net/sflogo.php?group_id=16035' width='88' height='31' border='0' alt='SourceForge Logo' />
</BODY>
</HTML>
|