📄 fidmapper.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.4.2_13) on Tue Jun 05 11:36:32 GMT-05:00 2007 --><META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><TITLE>FIDMapper (Geotools 2.3.x 2.3.2 API)</TITLE><META NAME="keywords" CONTENT="org.geotools.data.jdbc.fidmapper.FIDMapper interface"><META NAME="keywords" CONTENT="initSupportStructures()"><META NAME="keywords" CONTENT="getID()"><META NAME="keywords" CONTENT="getPKAttributes()"><META NAME="keywords" CONTENT="createID()"><META NAME="keywords" CONTENT="returnFIDColumnsAsAttributes()"><META NAME="keywords" CONTENT="getColumnCount()"><META NAME="keywords" CONTENT="getColumnName()"><META NAME="keywords" CONTENT="getColumnType()"><META NAME="keywords" CONTENT="getColumnSize()"><META NAME="keywords" CONTENT="getColumnDecimalDigits()"><META NAME="keywords" CONTENT="isAutoIncrement()"><META NAME="keywords" CONTENT="hasAutoIncrementColumns()"><META NAME="keywords" CONTENT="isVolatile()"><LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style"><SCRIPT type="text/javascript">function windowTitle(){ parent.document.title="FIDMapper (Geotools 2.3.x 2.3.2 API)";}</SCRIPT></HEAD><BODY BGCOLOR="white" onload="windowTitle();"><!-- ========= 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=3 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/FIDMapper.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/geotools/data/jdbc/fidmapper/FIDMapperFactory.html" title="interface in org.geotools.data.jdbc.fidmapper"><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="FIDMapper.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.geotools.data.jdbc.fidmapper</FONT><BR>Interface FIDMapper</H2><DL><DT><B>All Superinterfaces:</B> <DD><A HREF="http://java.sun.com/j2se/1.4/docs/api/java/io/Serializable.html" title="class or interface in java.io">Serializable</A></DD></DL><DL><DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../../../org/geotools/data/jdbc/fidmapper/AbstractFIDMapper.html" title="class in org.geotools.data.jdbc.fidmapper">AbstractFIDMapper</A>, <A HREF="../../../../../org/geotools/data/postgis/fidmapper/PostGISAutoIncrementFIDMapper.html" title="class in org.geotools.data.postgis.fidmapper">PostGISAutoIncrementFIDMapper</A></DD></DL><HR><DL><DT>public interface <B>FIDMapper</B><DT>extends <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/io/Serializable.html" title="class or interface in java.io">Serializable</A></DL><P><p> The FIDMapper interface manages the mapping of feature id to the identifiers provided in a database. </p> <p> Basically a FIDMapper must: <ul> <li> generate the FID (a String) given the set of values that compose the primary key in the database </li> <li> turn the FID into the primary key values, or generate them should the FID be null </li> <li> provide notice wheter the identifier values should be included as attributes in the feature or not (this is necessary when reverse engineering the feature type from the database metadata) </li> <li> describe the primary key columns, if any (this is necessary when creating the table that describes the feature type in a table) </li> </ul> </p> <p> Concrete instances of this class should provide support for the most common primary key mapping and generation strategis, such as pk with business meaning, serials, sequences, and so on </p> <p> Classes that implement this interface should ovveride equals to provide a state based comparison. </p><P><P><DL><DT><B>Author:</B></DT> <DD>Dani Daniele Franzoni, aaime Andrea Aime</DD><DT><B>Module:</B></DT><DD><CODE><B>module/main</B></CODE> (<A HREF="http://maven.geotools.fr/repository/org/geotools/gt2-main/"><CODE>gt2-main.jar</CODE></A>) (<A HREF="http://maven.geotools.fr/reports/main/index.html">Maven report</A>) (<A HREF="http://svn.geotools.org/geotools/tags/2.3.2/module/main/src/org/geotools/data/jdbc/fidmapper/FIDMapper.java">SVN head</A>)</DD></DL><HR><P><!-- ======== NESTED CLASS SUMMARY ======== --><!-- =========== FIELD SUMMARY =========== --><!-- ======== CONSTRUCTOR SUMMARY ======== --><!-- ========== METHOD SUMMARY =========== --><A NAME="method_summary"><!-- --></A><TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""><TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"><TD COLSPAN=2><FONT SIZE="+2"><B>Method Summary</B></FONT></TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE> <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A></CODE></FONT></TD><TD><CODE><B><A HREF="../../../../../org/geotools/data/jdbc/fidmapper/FIDMapper.html#createID(java.sql.Connection, org.geotools.feature.Feature, java.sql.Statement)">createID</A></B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/sql/Connection.html" title="class or interface in java.sql">Connection</A> conn, <A HREF="../../../../../org/geotools/feature/Feature.html" title="interface in org.geotools.feature">Feature</A> feature, <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/sql/Statement.html" title="class or interface in java.sql">Statement</A> statement)</CODE><BR> Creates a new ID for a feature. </TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE> int</CODE></FONT></TD><TD><CODE><B><A HREF="../../../../../org/geotools/data/jdbc/fidmapper/FIDMapper.html#getColumnCount()">getColumnCount</A></B>()</CODE><BR> Returns the number of columns in the primary keys handled by this mapper</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE> int</CODE></FONT></TD><TD><CODE><B><A HREF="../../../../../org/geotools/data/jdbc/fidmapper/FIDMapper.html#getColumnDecimalDigits(int)">getColumnDecimalDigits</A></B>(int colIndex)</CODE><BR> Provides the number of decimal digits for this column. </TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE> <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A></CODE></FONT></TD><TD><CODE><B><A HREF="../../../../../org/geotools/data/jdbc/fidmapper/FIDMapper.html#getColumnName(int)">getColumnName</A></B>(int colIndex)</CODE><BR> Returns the name of the specified column in the primary key</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE> int</CODE></FONT></TD><TD><CODE><B><A HREF="../../../../../org/geotools/data/jdbc/fidmapper/FIDMapper.html#getColumnSize(int)">getColumnSize</A></B>(int colIndex)</CODE><BR> Returns the size of a primary key column as it would be provided by the database metadata. </TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE> int</CODE></FONT></TD><TD><CODE><B><A HREF="../../../../../org/geotools/data/jdbc/fidmapper/FIDMapper.html#getColumnType(int)">getColumnType</A></B>(int colIndex)</CODE><BR> Returns the column type by using a constant available in the java.sql.Types interface</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE> <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A></CODE></FONT></TD><TD><CODE><B><A HREF="../../../../../org/geotools/data/jdbc/fidmapper/FIDMapper.html#getID(java.lang.Object[])">getID</A></B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A>[] attributes)</CODE><BR> Returns the FID given the values of the prymary key attributes</TD></TR><TR BGCOLOR="white" CLASS="TableRowColor"><TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"><CODE> <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/Object.html" title="class or interface in java.lang">Object</A>[]</CODE></FONT></TD><TD><CODE><B><A HREF="../../../../../org/geotools/data/jdbc/fidmapper/FIDMapper.html#getPKAttributes(java.lang.String)">getPKAttributes</A></B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> FID)</CODE><BR> Creates the value for the PK attributes given the feature. </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/geotools/data/jdbc/fidmapper/FIDMapper.html#hasAutoIncrementColumns()">hasAutoIncrementColumns</A></B>()</CODE><BR> Returns true if at least one column is of auto-increment type</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/geotools/data/jdbc/fidmapper/FIDMapper.html#initSupportStructures()">initSupportStructures</A></B>()</CODE><BR> This method will be called by JDBCDataStore when creating new tables to give the FID mapper an opportunity to initialize needed data structures, such as support tables, sequences, and so on.</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/geotools/data/jdbc/fidmapper/FIDMapper.html#isAutoIncrement(int)">isAutoIncrement</A></B>(int colIndex)</CODE><BR> Returns true if the column is of serial type, that is, its value is automatically generated by the database if the user does not provide one</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/geotools/data/jdbc/fidmapper/FIDMapper.html#isVolatile()">isVolatile</A></B>()</CODE><BR> Returns true it the FID generated by this mapper are volatile, that is, if asking twice for the same Feature will not provide the same FID. </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/geotools/data/jdbc/fidmapper/FIDMapper.html#returnFIDColumnsAsAttributes()">returnFIDColumnsAsAttributes</A></B>()</CODE><BR> If true the primary key columns will be returned as attributes. </TD></TR></TABLE> <P><!-- ============ FIELD DETAIL =========== --><!-- ========= CONSTRUCTOR DETAIL ======== --><!-- ============ METHOD DETAIL ========== --><A NAME="method_detail"><!-- --></A><TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""><TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"><TD COLSPAN=1><FONT SIZE="+2">⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -