datastorefactoryspi.html

Geotools是一个开源的Java GIS工具包,可利用它来开发符合标准的地理信息系统。Geotools提供了OGC(Open Geospatial Consortium)规范的一个实现来作为他们的

<TD><CODE><A HREF="../../../org/geotools/factory/Factory.html#getImplementationHints()">getImplementationHints</A></CODE></TD>
</TR>
</TABLE>
&nbsp;
<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">
<B>Method Detail</B></FONT></TD>
</TR>
</TABLE>

<A NAME="createDataStore(java.util.Map)"><!-- --></A><H3>
createDataStore</H3>
<PRE>
public <A HREF="../../../org/geotools/data/DataStore.html" title="interface in org.geotools.data">DataStore</A> <B>createDataStore</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/util/Map.html" title="class or interface in java.util">Map</A>&nbsp;params)
                          throws <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/io/IOException.html" title="class or interface in java.io">IOException</A></PRE>
<DL>
<DD>Construct a live data source using the params specifed.

 <p>
 You can think of this as setting up a connection to the back end data
 source.
 </p>

 <p>
 Magic Params: the following params are magic and are honoured by
 convention by the GeoServer and uDig application.

 <ul>
 <li>
 "user": is taken to be the user name
 </li>
 <li>
 "passwd": is taken to be the password
 </li>
 <li>
 "namespace": is taken to be the namespace prefix (and will be kept in
 sync with GeoServer namespace management.
 </li>
 </ul>

 When we eventually move over to the use of OpperationalParam we will
 have to find someway to codify this convention.
 </p>
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>params</CODE> - The full set of information needed to construct a live
        data store. Typical key values for the map include: url -
        location of a resource, used by file reading datasources. dbtype
        - the type of the database to connect to, e.g. postgis, mysql
<DT><B>Returns:</B><DD>The created DataStore, this may be null if the required resource
         was not found or if insufficent parameters were given. Note
         that canProcess() should have returned false if the problem is
         to do with insuficent parameters.
<DT><B>Throws:</B>
<DD><CODE>IOException</CODE> - if there were any problems setting up (creating or
         connecting) the datasource.</DL>
</DD>
</DL>
<HR>

<A NAME="createNewDataStore(java.util.Map)"><!-- --></A><H3>
createNewDataStore</H3>
<PRE>
public <A HREF="../../../org/geotools/data/DataStore.html" title="interface in org.geotools.data">DataStore</A> <B>createNewDataStore</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/util/Map.html" title="class or interface in java.util">Map</A>&nbsp;params)
                             throws <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/io/IOException.html" title="class or interface in java.io">IOException</A></PRE>
<DL>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>Throws:</B>
<DD><CODE><A HREF="http://java.sun.com/j2se/1.4/docs/api/java/io/IOException.html" title="class or interface in java.io">IOException</A></CODE></DL>
</DD>
</DL>
<HR>

<A NAME="getDisplayName()"><!-- --></A><H3>
getDisplayName</H3>
<PRE>
public <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>getDisplayName</B>()</PRE>
<DL>
<DD>Name suitable for display to end user.

 <p>
 A non localized display name for this data store type.
 </p>
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>A short name suitable for display in a user interface.</DL>
</DD>
</DL>
<HR>

<A NAME="getDescription()"><!-- --></A><H3>
getDescription</H3>
<PRE>
public <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/String.html" title="class or interface in java.lang">String</A> <B>getDescription</B>()</PRE>
<DL>
<DD>Describe the nature of the datasource constructed by this factory.

 <p>
 A non localized description of this data store type.
 </p>
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>A human readable description that is suitable for inclusion in a
         list of available datasources.</DL>
</DD>
</DL>
<HR>

<A NAME="getParametersInfo()"><!-- --></A><H3>
getParametersInfo</H3>
<PRE>
public <A HREF="../../../org/geotools/data/DataStoreFactorySpi.Param.html" title="class in org.geotools.data">DataStoreFactorySpi.Param</A>[] <B>getParametersInfo</B>()</PRE>
<DL>
<DD>MetaData about the required Parameters (for createDataStore).

 <p>
 Interpretation of FeatureDescriptor values:
 </p>

 <ul>
 <li>
 getDisplayName(): Gets the localized display name of this feature.
 </li>
 <li>
 getName(): Gets the programmatic name of this feature (used as the key
 in params)
 </li>
 <li>
 getShortDescription(): Gets the short description of this feature.
 </li>
 </ul>

 <p>
 This should be the same as:
 </p>
 <pre><code>
 Object params = factory.getParameters();
 BeanInfo info = getBeanInfo( params );

 return info.getPropertyDescriptors();
 <code></pre>
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD>Param array describing the Map for createDataStore</DL>
</DD>
</DL>
<HR>

<A NAME="canProcess(java.util.Map)"><!-- --></A><H3>
canProcess</H3>
<PRE>
public boolean <B>canProcess</B>(<A HREF="http://java.sun.com/j2se/1.4/docs/api/java/util/Map.html" title="class or interface in java.util">Map</A>&nbsp;params)</PRE>
<DL>
<DD>Test to see if this factory is suitable for processing the data pointed
 to by the params map.

 <p>
 If this datasource requires a number of parameters then this mehtod
 should check that they are all present and that they are all valid. If
 the datasource is a file reading data source then the extentions or
 mime types of any files specified should be checked. For example, a
 Shapefile datasource should check that the url param ends with shp,
 such tests should be case insensative.
 </p>
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>params</CODE> - The full set of information needed to construct a live
        data source.
<DT><B>Returns:</B><DD>booean true if and only if this factory can process the resource
         indicated by the param set and all the required params are
         pressent.</DL>
</DD>
</DL>
<HR>

<A NAME="isAvailable()"><!-- --></A><H3>
isAvailable</H3>
<PRE>
public boolean <B>isAvailable</B>()</PRE>
<DL>
<DD>Test to see if this datastore is available, if it has all the
 appropriate libraries to construct a datastore.  Most datastores should
 return true, because geotools will distribute the appropriate
 libraries.  Though it's not a bad idea for DataStoreFactories to check
 to make sure that the  libraries are there.  OracleDataStoreFactory is
 an example of one that may generally return false, since geotools can
 not distribute the oracle jars, they must be added by the client.  One
 may ask how this is different than canProcess, and basically available
 is used by the DataStoreFinder getAvailableDataStore method, so that
 DataStores that can not even be used do not show up as options in gui
 applications.
<P>
<DD><DL>
</DL>
</DD>
<DD><DL>

<DT><B>Returns:</B><DD><tt>true</tt> if and only if this factory has all the
         appropriate jars on the classpath to create DataStores.</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=3 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>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/DataStoreFactorySpi.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  </TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>

<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../../org/geotools/data/DataStore.html" title="interface in org.geotools.data"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../org/geotools/data/FeatureListener.html" title="interface in org.geotools.data"><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>  &nbsp;
&nbsp;<A HREF="DataStoreFactorySpi.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
&nbsp;<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:&nbsp;<A HREF="#nested_class_summary">NESTED</A>&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->

<HR>
Copyright &copy; 1996-2007 <a href="http://www.geotools.org">Geotools</a>. All Rights Reserved.
</BODY>
</HTML>