447 lines
14 KiB
HTML
447 lines
14 KiB
HTML
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN""http://www.w3.org/TR/REC-html40/loose.dtd">
|
|
<!--NewPage-->
|
|
<HTML>
|
|
<HEAD>
|
|
<TITLE>
|
|
jala.IndexManager.Job
|
|
</TITLE>
|
|
<LINK REL ="stylesheet" TYPE="text/css" HREF="stylesheet.css" TITLE="Style">
|
|
</HEAD>
|
|
<SCRIPT>
|
|
function asd()
|
|
{
|
|
parent.document.title="jala.IndexManager.Job";
|
|
}
|
|
</SCRIPT>
|
|
<BODY BGCOLOR="white" onload="asd();">
|
|
|
|
<!-- ========== START OF NAVBAR ========== -->
|
|
<A NAME="navbar_bottom"><!-- --></A>
|
|
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
|
|
<TR>
|
|
<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
|
|
<A NAME="navbar_bottom_firstrow"><!-- --></A>
|
|
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
|
|
<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="overview-summary-IndexManager.js.html"><FONT CLASS="NavBarFont1"><B>File</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="overview-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
|
|
<!--TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"--> <!--A HREF="deprecated-list.html"--><!--FONT CLASS="NavBarFont1">Deprecated</FONT--><!--/A--><!-- </TD-->
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="index-all.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>
|
|
<B>Jala 1.3</B>
|
|
</EM>
|
|
</TD
|
|
</TR>
|
|
|
|
<TR>
|
|
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
|
<A HREF="jala.IndexManager.html"><B>PREV CLASS</B></A><!--
|
|
NEXT CLASS
|
|
-->
|
|
<A HREF="jala.ListRenderer.html"><B>NEXT CLASS</B></A></FONT></TD>
|
|
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
|
<A HREF="index.html" TARGET="_top"><B>FRAMES</B></A>
|
|
<A HREF="jala.IndexManager.Job.html" TARGET="_top"><B>NO FRAMES</B></A>
|
|
|
|
<SCRIPT>
|
|
<!--
|
|
if(window==top) {
|
|
document.writeln('<A HREF="allclasses-noframe.html" TARGET=""><B>All Classes</B></A>');
|
|
}
|
|
//-->
|
|
</SCRIPT>
|
|
<NOSCRIPT>
|
|
<A HREF="allclasses-noframe.html" TARGET=""><B>All Classes</B></A>
|
|
</NOSCRIPT>
|
|
</FONT></TD>
|
|
</TR>
|
|
<TR>
|
|
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
|
SUMMARY: <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
|
|
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
|
DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
|
|
</TR>
|
|
</TABLE>
|
|
<!-- =========== END OF NAVBAR =========== -->
|
|
<HR>
|
|
|
|
<!-- ======== START OF CLASS DATA ======== -->
|
|
<H2>Class jala.IndexManager.Job</H2>
|
|
<PRE>Object
|
|
|
|
|
+--<b>jala.IndexManager.Job</b>
|
|
</PRE>
|
|
|
|
|
|
<HR>
|
|
<DL>
|
|
<!-- Class definition -->
|
|
<DT>class
|
|
<B>jala.IndexManager.Job</B>
|
|
|
|
|
|
</DL>
|
|
|
|
<P>
|
|
<BR/>Instances of this class represent a single index
|
|
manipulation job to be processed by the index manager.
|
|
<BR/><I>Defined in <a href='overview-summary-IndexManager.js.html'>IndexManager.js</a></I><BR/><BR/><B>See:</B><UL>- <a href="jala.IndexManager.Job.html#">jala.IndexManager.Job</a></UL>
|
|
</P>
|
|
|
|
<HR>
|
|
|
|
<!-- ======== NESTED CLASS SUMMARY ======== -->
|
|
|
|
<!-- ======== END NESTED CLASS SUMMARY ======== -->
|
|
|
|
|
|
<!-- =========== FIELD SUMMARY =========== -->
|
|
|
|
<A NAME="field_summary"><!-- --></A>
|
|
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
|
|
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
|
<TD COLSPAN=2><FONT SIZE="+2">
|
|
<B>Field Summary</B></FONT></TD>
|
|
</TR>
|
|
|
|
<!-- This is one instance field summary -->
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> Object</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="#callback">callback</A></B></CODE>
|
|
<BR>
|
|
The data needed to process this job.</TD>
|
|
</TR>
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> Date</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="#createtime">createtime</A></B></CODE>
|
|
<BR>
|
|
The date and time at which this job was created.</TD>
|
|
</TR>
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> Number</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="#errors">errors</A></B></CODE>
|
|
<BR>
|
|
An internal error counter which is increased whenever processing
|
|
the job failed.</TD>
|
|
</TR>
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE> Number</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="#type">type</A></B></CODE>
|
|
<BR>
|
|
The type of the job</TD>
|
|
</TR>
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE><static> <final> Number</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="#!s!ADD">ADD</A></B></CODE>
|
|
<BR>
|
|
Constant defining an add job</TD>
|
|
</TR>
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE><static> <final> Number</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="#!s!OPTIMIZE">OPTIMIZE</A></B></CODE>
|
|
<BR>
|
|
Constant defining an optimizing job</TD>
|
|
</TR>
|
|
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
|
|
<CODE><static> <final> Number</CODE></FONT></TD>
|
|
<TD><CODE><B><A HREF="#!s!REMOVE">REMOVE</A></B></CODE>
|
|
<BR>
|
|
Constant defining a removal job</TD>
|
|
</TR>
|
|
|
|
|
|
</TABLE>
|
|
|
|
|
|
|
|
|
|
|
|
<!-- =========== END FIELD SUMMARY =========== -->
|
|
|
|
|
|
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
|
|
|
<A NAME="constructor_summary"><!-- --></A>
|
|
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
|
|
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
|
<TD COLSPAN=2><FONT SIZE="+2">
|
|
<B>Constructor Summary</B></FONT></TD>
|
|
</TR>
|
|
<TR BGCOLOR="white" CLASS="TableRowColor">
|
|
<TD>
|
|
<CODE>
|
|
<B>
|
|
<A HREF="jala.IndexManager.Job.html#jala.IndexManager.Job()">jala.IndexManager.Job</A>
|
|
</B>
|
|
(<Number> type, callback)
|
|
</CODE>
|
|
<BR>
|
|
|
|
Creates a new Job instance.
|
|
</TD>
|
|
</TR>
|
|
</TABLE>
|
|
|
|
<!-- ======== END CONSTRUCTOR SUMMARY ======== -->
|
|
|
|
|
|
|
|
<!-- ========== METHOD SUMMARY =========== -->
|
|
|
|
|
|
|
|
<P>
|
|
<!-- ========== END METHOD SUMMARY =========== -->
|
|
|
|
|
|
<!-- ============ FIELD DETAIL START =========== -->
|
|
|
|
<A NAME="field_detail"><!-- --></A>
|
|
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
|
|
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
|
<TD COLSPAN=1><FONT SIZE="+2"><B>Field Detail</B></FONT></TD>
|
|
</TR>
|
|
</TABLE>
|
|
|
|
|
|
<A NAME="callback"><!-- --></A>
|
|
<H3>callback</H3>
|
|
<PRE>Object <B>callback</B></PRE>
|
|
<UL>
|
|
The data needed to process this job. For adding jobs this property
|
|
must contain the helma.Search.Document instance to add to
|
|
the index. For removal job this property must contain the unique identifier
|
|
of the document that should be removed from the index. For optimizing
|
|
jobs this property is null.
|
|
|
|
</UL>
|
|
<HR>
|
|
|
|
<A NAME="createtime"><!-- --></A>
|
|
<H3>createtime</H3>
|
|
<PRE>Date <B>createtime</B></PRE>
|
|
<UL>
|
|
The date and time at which this job was created.
|
|
|
|
</UL>
|
|
<HR>
|
|
|
|
<A NAME="errors"><!-- --></A>
|
|
<H3>errors</H3>
|
|
<PRE>Number <B>errors</B></PRE>
|
|
<UL>
|
|
An internal error counter which is increased whenever processing
|
|
the job failed.
|
|
|
|
</UL>
|
|
<HR>
|
|
|
|
<A NAME="type"><!-- --></A>
|
|
<H3>type</H3>
|
|
<PRE>Number <B>type</B></PRE>
|
|
<UL>
|
|
The type of the job
|
|
|
|
</UL>
|
|
<HR>
|
|
|
|
<A NAME="!s!ADD"><!-- --></A>
|
|
<H3>ADD</H3>
|
|
<PRE><static> <final> Number <B>ADD</B></PRE>
|
|
<UL>
|
|
Constant defining an add job
|
|
|
|
<P>
|
|
<DL>
|
|
<DT><B>See Also:</B><DD><A HREF="constant-values.html#java.awt.AWTEvent.COMPONENT_EVENT_MASK">Constant Field Values</A></DL>
|
|
</DL>
|
|
|
|
|
|
</UL>
|
|
<HR>
|
|
|
|
<A NAME="!s!OPTIMIZE"><!-- --></A>
|
|
<H3>OPTIMIZE</H3>
|
|
<PRE><static> <final> Number <B>OPTIMIZE</B></PRE>
|
|
<UL>
|
|
Constant defining an optimizing job
|
|
|
|
<P>
|
|
<DL>
|
|
<DT><B>See Also:</B><DD><A HREF="constant-values.html#java.awt.AWTEvent.COMPONENT_EVENT_MASK">Constant Field Values</A></DL>
|
|
</DL>
|
|
|
|
|
|
</UL>
|
|
<HR>
|
|
|
|
<A NAME="!s!REMOVE"><!-- --></A>
|
|
<H3>REMOVE</H3>
|
|
<PRE><static> <final> Number <B>REMOVE</B></PRE>
|
|
<UL>
|
|
Constant defining a removal job
|
|
|
|
<P>
|
|
<DL>
|
|
<DT><B>See Also:</B><DD><A HREF="constant-values.html#java.awt.AWTEvent.COMPONENT_EVENT_MASK">Constant Field Values</A></DL>
|
|
</DL>
|
|
|
|
|
|
</UL>
|
|
<HR>
|
|
|
|
|
|
|
|
<!-- ============ FIELD DETAIL END =========== -->
|
|
|
|
<!-- ========= CONSTRUCTOR DETAIL START ======== -->
|
|
|
|
<A NAME="constructor_detail"><!-- --></A>
|
|
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
|
|
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
|
|
<TD COLSPAN=1>
|
|
<FONT SIZE="+2"><B>Constructor Detail</B></FONT>
|
|
</TD>
|
|
</TR>
|
|
</TABLE>
|
|
|
|
<A NAME="jala.IndexManager.Job()"><!-- --></A><H3>
|
|
jala.IndexManager.Job</H3>
|
|
<PRE><B>jala.IndexManager.Job</B>(<Number> type, callback)</PRE>
|
|
|
|
|
|
<UL>
|
|
Creates a new Job instance.
|
|
</UL>
|
|
|
|
|
|
|
|
<UL>
|
|
<B>Parameters:</B>
|
|
|
|
<UL><CODE>type</CODE> - The type of job, which can be either jala.IndexManager.Job.ADD, jala.IndexManager.Job.REMOVE or jala.IndexManager.Job.OPTIMIZE.
|
|
</UL>
|
|
|
|
<UL><CODE>id</CODE> - The Id of the job
|
|
</UL>
|
|
|
|
<UL><CODE>data</CODE> - The data needed to process the job.
|
|
</UL>
|
|
|
|
|
|
</UL>
|
|
|
|
|
|
<!-- Constructor return value(s) -->
|
|
|
|
<UL>
|
|
<B>Returns:</B>
|
|
<UL>
|
|
A newly created Job instance.
|
|
</UL>
|
|
</UL>
|
|
|
|
<!-- End constructor return value(s) -->
|
|
|
|
<!-- ADDITIONAL ATTRIBUTES -->
|
|
|
|
<UL>
|
|
<B>See:</B><UL>- <a href="jala.IndexManager.Job.html#">jala.IndexManager.Job</a></UL>
|
|
</UL>
|
|
|
|
<HR/>
|
|
<!-- END ADDITIONAL ATTRIBUTES -->
|
|
|
|
<!-- ========= CONSTRUCTOR DETAIL END ======== -->
|
|
|
|
|
|
<!-- ============ METHOD DETAIL START ========== -->
|
|
|
|
|
|
<!-- ============ METHOD DETAIL END ========== -->
|
|
|
|
<!-- ========= END OF CLASS DATA ========= -->
|
|
|
|
<!-- ========== START OF NAVBAR ========== -->
|
|
<A NAME="navbar_bottom"><!-- --></A>
|
|
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
|
|
<TR>
|
|
<TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
|
|
<A NAME="navbar_bottom_firstrow"><!-- --></A>
|
|
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
|
|
<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="overview-summary-IndexManager.js.html"><FONT CLASS="NavBarFont1"><B>File</B></FONT></A> </TD>
|
|
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="overview-tree.html"><FONT CLASS="NavBarFont1"><b>Tree</b></FONT></A> </TD>
|
|
<!--TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"--> <!--A HREF="deprecated-list.html"--><!--FONT CLASS="NavBarFont1">Deprecated</FONT--><!--/A--><!-- </TD-->
|
|
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="index-all.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>
|
|
<B>Jala 1.3</B>
|
|
</EM>
|
|
</TD
|
|
</TR>
|
|
|
|
<TR>
|
|
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
|
<A HREF="jala.IndexManager.html"><B>PREV CLASS</B></A><!--
|
|
NEXT CLASS
|
|
-->
|
|
<A HREF="jala.ListRenderer.html"><B>NEXT CLASS</B></A></FONT></TD>
|
|
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
|
|
<A HREF="index.html" TARGET="_top"><B>FRAMES</B></A>
|
|
<A HREF="jala.IndexManager.Job.html" TARGET="_top"><B>NO FRAMES</B></A>
|
|
|
|
<SCRIPT>
|
|
<!--
|
|
if(window==top) {
|
|
document.writeln('<A HREF="allclasses-noframe.html" TARGET=""><B>All Classes</B></A>');
|
|
}
|
|
//-->
|
|
</SCRIPT>
|
|
<NOSCRIPT>
|
|
<A HREF="allclasses-noframe.html" TARGET=""><B>All Classes</B></A>
|
|
</NOSCRIPT>
|
|
</FONT></TD>
|
|
</TR>
|
|
<TR>
|
|
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
|
SUMMARY: <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD>
|
|
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
|
|
DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD>
|
|
</TR>
|
|
</TABLE>
|
|
|
|
<!-- =========== END OF NAVBAR =========== -->
|
|
|
|
<HR>
|
|
<FONT SIZE="-1">
|
|
|
|
</FONT>
|
|
<div class="jsdoc_ctime">Documentation generated by <a href="http://jsdoc.sourceforge.net/" target="_parent">JSDoc</a> on Tue Jan 8 15:45:31 2008</div>
|
|
</BODY>
|
|
</HTML>
|