📄 ontologyformatting.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:27 GMT 2008 -->
<TITLE>
OntologyFormatting
</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="OntologyFormatting";
}
}
</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/OntologyFormatting.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">
<A HREF="../../../../../org/semanticweb/kaon2/api/formatting/OntologyFileFormat.html" title="class in org.semanticweb.kaon2.api.formatting"><B>PREV CLASS</B></A>
NEXT CLASS</FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../../../index.html?org/semanticweb/kaon2/api/formatting/OntologyFormatting.html" target="_top"><B>FRAMES</B></A>
<A HREF="OntologyFormatting.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 OntologyFormatting</H2>
<HR>
<DL>
<DT><PRE>public interface <B>OntologyFormatting</B></DL>
</PRE>
<P>
Represents the information about how axioms are formatted in an ontology. Formatting is preserved for an ontology only if the parameter "preserveFormatting" is set to Boolean.TRUE in the parameters hashmap when an ontology is opened or created. From the textual point of view, an ontology is a sequence of formatting elements. There are two types of elements: (i) axiom elements correspond to axioms in the ontology, whereas (ii) whitespace elements correspond to whitespace (possibly including comments) that come between axioms. Some implementations of this interface keep formatting only for one type of axioms (for example, to prevent huge memory consumption, one might choose not to preserve formatting for facts). Using cursors one can separately iterate over both classes of axioms.
<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> void</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/semanticweb/kaon2/api/formatting/OntologyFormatting.html#addWhitespaceAfter(org.semanticweb.kaon2.api.Axiom, java.lang.String)">addWhitespaceAfter</A></B>(<A HREF="../../../../../org/semanticweb/kaon2/api/Axiom.html" title="interface in org.semanticweb.kaon2.api">Axiom</A> axiom,
java.lang.String text)</CODE>
<BR>
Adds a whitespace formatting element after the given 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/OntologyFormatting.html#addWhitespaceBefore(org.semanticweb.kaon2.api.Axiom, java.lang.String)">addWhitespaceBefore</A></B>(<A HREF="../../../../../org/semanticweb/kaon2/api/Axiom.html" title="interface in org.semanticweb.kaon2.api">Axiom</A> axiom,
java.lang.String text)</CODE>
<BR>
Adds a whitespace formatting element before the given axiom.</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/OntologyFormatting.html#canPreserveFormattingForAxiom(org.semanticweb.kaon2.api.Axiom)">canPreserveFormattingForAxiom</A></B>(<A HREF="../../../../../org/semanticweb/kaon2/api/Axiom.html" title="interface in org.semanticweb.kaon2.api">Axiom</A> axiom)</CODE>
<BR>
Returns <code>true</code> if formatting can be preserved for ths supplied 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/OntologyFormatting.html#clear()">clear</A></B>()</CODE>
<BR>
Clear the formatting for all objects.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../../../org/semanticweb/kaon2/api/formatting/FormattingElementCursor.html" title="interface in org.semanticweb.kaon2.api.formatting">FormattingElementCursor</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/semanticweb/kaon2/api/formatting/OntologyFormatting.html#createNonPreservedAxiomsCursor()">createNonPreservedAxiomsCursor</A></B>()</CODE>
<BR>
Creates a cursor over the axioms whose formating is not being preserved.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../../../org/semanticweb/kaon2/api/formatting/FormattingElementCursor.html" title="interface in org.semanticweb.kaon2.api.formatting">FormattingElementCursor</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/semanticweb/kaon2/api/formatting/OntologyFormatting.html#createPreservedAxiomsCursor()">createPreservedAxiomsCursor</A></B>()</CODE>
<BR>
Creates a cursor over the axioms whose formating is being preserved.</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/OntologyFormatting.html#deleteWhitespaceAfter(org.semanticweb.kaon2.api.Axiom)">deleteWhitespaceAfter</A></B>(<A HREF="../../../../../org/semanticweb/kaon2/api/Axiom.html" title="interface in org.semanticweb.kaon2.api">Axiom</A> axiom)</CODE>
<BR>
Deletes all whitespace elements after the given 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/OntologyFormatting.html#deleteWhitespaceBefore(org.semanticweb.kaon2.api.Axiom)">deleteWhitespaceBefore</A></B>(<A HREF="../../../../../org/semanticweb/kaon2/api/Axiom.html" title="interface in org.semanticweb.kaon2.api">Axiom</A> axiom)</CODE>
<BR>
Deletes all whitespace elements before the given axiom.</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/OntologyFormatting.html#formattingPreservationEnabled()">formattingPreservationEnabled</A></B>()</CODE>
<BR>
Returns <code>true</code> if formatting prservation has been enabled at ontology creation/opening time.</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/OntologyFormatting.html#getAxiomText(org.semanticweb.kaon2.api.Axiom)">getAxiomText</A></B>(<A HREF="../../../../../org/semanticweb/kaon2/api/Axiom.html" title="interface in org.semanticweb.kaon2.api">Axiom</A> axiom)</CODE>
<BR>
Returns the string representation of an axiom.</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/OntologyFormatting.html#getFormatName()">getFormatName</A></B>()</CODE>
<BR>
Returns the name of the ontology format.</TD>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> <A HREF="../../../../../org/semanticweb/kaon2/api/Namespaces.html" title="class in org.semanticweb.kaon2.api">Namespaces</A></CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../../../org/semanticweb/kaon2/api/formatting/OntologyFormatting.html#getNamespaces()">getNamespaces</A></B>()</CODE>
<BR>
Returns the namespaces of the ontology.</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/OntologyFormatting.html#registerNamespacePrefix(java.lang.String, java.lang.String)">registerNamespacePrefix</A></B>(java.lang.String prefix,
java.lang.String namespace)</CODE>
<BR>
Registers a mapping prefix for the namespace.</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/OntologyFormatting.html#setAxiomText(org.semanticweb.kaon2.api.Axiom, java.lang.String)">setAxiomText</A></B>(<A HREF="../../../../../org/semanticweb/kaon2/api/Axiom.html" title="interface in org.semanticweb.kaon2.api">Axiom</A> axiom,
java.lang.String text)</CODE>
<BR>
Sets the text of the given axiom.</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="getFormatName()"><!-- --></A><H3>
getFormatName</H3>
<PRE>
java.lang.String <B>getFormatName</B>()
throws <A HREF="../../../../../org/semanticweb/kaon2/api/KAON2Exception.html" title="class in org.semanticweb.kaon2.api">KAON2Exception</A></PRE>
<DL>
<DD>Returns the name of the ontology format.
<P>
<DD><DL>
<DT><B>Returns:</B><DD>the name of the ontology format
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../../org/semanticweb/kaon2/api/KAON2Exception.html" title="class in org.semanticweb.kaon2.api">KAON2Exception</A></CODE> - thrown if there is an error</DL>
</DD>
</DL>
<HR>
<A NAME="formattingPreservationEnabled()"><!-- --></A><H3>
formattingPreservationEnabled</H3>
<PRE>
boolean <B>formattingPreservationEnabled</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 formatting prservation has been enabled at ontology creation/opening time. If formatting preservation has not been enabled, then metods that attempt to mutate the state of this object will fail.
⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -