📄 formattingelementcursor.html
字号:
<!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_02) on Mon Jan 14 15:06:26 GMT 2008 -->
<TITLE>
FormattingElementCursor
</TITLE>
<META NAME="date" CONTENT="2008-01-14">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="FormattingElementCursor";
}
}
</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/FormattingElementCursor.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-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>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
PREV CLASS
<A HREF="../../../../../org/semanticweb/kaon2/api/formatting/OntologyFileFormat.html" title="class in org.semanticweb.kaon2.api.formatting"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html?org/semanticweb/kaon2/api/formatting/FormattingElementCursor.html" target="_top"><B>FRAMES</B></A>
<A HREF="FormattingElementCursor.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 | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: FIELD | 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.semanticweb.kaon2.api.formatting</FONT>
<BR>
Interface FormattingElementCursor</H2>
<HR>
<DL>
<DT><PRE>public interface <B>FormattingElementCursor</B></DL>
</PRE>
<P>
This interface allows to iterate and manipulate formatting elements in an ontology. At any given instant, an object of this class is positioned either before the first element, after the last element, or on some formatting element. If the current formatting element is an axiom, this axiom can be retrieved using <code>getCurrentAxiom()</code>; if the current formatting element is not an axiom, then <code>getCurrentAxiom()</code> returns null. The text of the current formattig element can be retrieved using <code>getCurrentText()</code>. Certain axioms may not have text associated with them; in this case, <code>getCurrentText()</code> returns null. Formatting elements can be deleted, after which the cursor moves to either the previous of the next element. It is important to understand that axiom formatting elements represent only information about axiom formatting, and not the axioms themselves. Therefore, if an axiom formatting element is deleted, the axiom is not deleted from the ontology. Each axiom in the ontology must be represented by a formatting element, so deleting an axiom formatting element actually creates a new formatting element at the end of the ontology with the deleted axiom and the empty text. This class does not ensure syntactic correctness of the texts it keeps. As with Java collections, one should not modify the underlying formatting object while iterating over it using a cursor, as this might leave the cursor in an inconsistent state. The ontology is locked for reading while a cursor is active. After a cursor is not needed any more, it should be disposed of by a call to the <code>close()</code> method; this unlocks the ontology and disposes of other resources.
<P>
<P>
<HR>
<P>
<!-- ========== 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> boolean</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/semanticweb/kaon2/api/formatting/FormattingElementCursor.html#afterLast()">afterLast</A></B>()</CODE>
<BR>
Returns <code>true</code> if this iterator is after the last formatting element.</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/semanticweb/kaon2/api/formatting/FormattingElementCursor.html#beforeFirst()">beforeFirst</A></B>()</CODE>
<BR>
Returns <code>true</code> if this iterator is before the first formatting element</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/semanticweb/kaon2/api/formatting/FormattingElementCursor.html#close()">close</A></B>()</CODE>
<BR>
Closes the cursor, unlocks the ontology, and releases all resources used.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/semanticweb/kaon2/api/formatting/FormattingElementCursor.html#delete(boolean)">delete</A></B>(boolean moveNext)</CODE>
<BR>
Deletes the current formatting element.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../../../org/semanticweb/kaon2/api/Axiom.html" title="interface in org.semanticweb.kaon2.api">Axiom</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/semanticweb/kaon2/api/formatting/FormattingElementCursor.html#getCurrentAxiom()">getCurrentAxiom</A></B>()</CODE>
<BR>
Returns the axiom of the current formatting element.</TD>
</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/semanticweb/kaon2/api/formatting/FormattingElementCursor.html#getCurrentText()">getCurrentText</A></B>()</CODE>
<BR>
Returns the text at the current formatting element.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/semanticweb/kaon2/api/formatting/FormattingElementCursor.html#goToAfterLast()">goToAfterLast</A></B>()</CODE>
<BR>
Moves to after the last element.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/semanticweb/kaon2/api/formatting/FormattingElementCursor.html#goToAxiom(org.semanticweb.kaon2.api.Axiom)">goToAxiom</A></B>(<A HREF="../../../../../org/semanticweb/kaon2/api/Axiom.html" title="interface in org.semanticweb.kaon2.api">Axiom</A> axiom)</CODE>
<BR>
Moves to the specified axiom.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/semanticweb/kaon2/api/formatting/FormattingElementCursor.html#goToBeforeFirst()">goToBeforeFirst</A></B>()</CODE>
<BR>
Moves to before the first element.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/semanticweb/kaon2/api/formatting/FormattingElementCursor.html#next()">next</A></B>()</CODE>
<BR>
Moves to the next formatting element.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/semanticweb/kaon2/api/formatting/FormattingElementCursor.html#previous()">previous</A></B>()</CODE>
<BR>
Moves to the previous formatting element.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/semanticweb/kaon2/api/formatting/FormattingElementCursor.html#setCurrentText(java.lang.String)">setCurrentText</A></B>(java.lang.String text)</CODE>
<BR>
Sets the text of the current formatting element.</TD>
</TR>
</TABLE>
<P>
<!-- ============ 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="afterLast()"><!-- --></A><H3>
afterLast</H3>
<PRE>
boolean <B>afterLast</B>()
throws <A HREF="../../../../../org/semanticweb/kaon2/api/KAON2Exception.html" title="class in org.semanticweb.kaon2.api">KAON2Exception</A></PRE>
<DL>
<DD>Returns <code>true</code> if this iterator is after the last formatting element.
<P>
<DD><DL>
<DT><B>Returns:</B><DD><code>true</code> if this iterator is after the last formatting element
<DT><B>Throws:</B>
⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -