Java Doc for AbstractDataStore.java in  » GIS » GeoTools-2.4.1 » org » geotools » data » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » GIS » GeoTools 2.4.1 » org.geotools.data 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   org.geotools.data.AbstractDataStore

All known Subclasses:   org.geotools.data.feature.memory.MemoryDataAccess,  org.geotools.data.memory.MemoryDataStore,  org.geotools.arcsde.data.ArcSDEDataStore,  org.geotools.data.tiger.TigerDataStore,  org.geotools.data.ogr.OGRDataStore,  org.geotools.data.mif.MIFDataStore,  org.geotools.data.vpf.file.VPFFileStore,  org.geotools.data.vpf.VPFLibrary,  org.geotools.data.AbstractFileDataStore,  org.geotools.data.wfs.WFSDataStore,  org.geotools.data.collection.CollectionDataStore,  org.geotools.data.gml.FileGMLDataStore,  org.geotools.caching.impl.AbstractDataCache,  org.geotools.caching.impl.InMemoryDataCache,  org.geotools.data.property.PropertyDataStore,
AbstractDataStore
abstract public class AbstractDataStore implements DataStore(Code)
Represents a stating point for implementing your own DataStore.

The goal is to have this class provide everything else if you can only provide:

  • String[] getFeatureTypes()
  • FeatureType getSchema(String typeName)
  • FeatureReader getFeatureReader( typeName )
  • FeatureWriter getFeatureWriter( typeName )
and optionally this protected methods to allow custom query optimizations:
  • Filter getUnsupportedFilter(String typeName, Filter filter)
  • FeatureReader getFeatureReader(String typeName, Query query)

All remaining functionality is implemented against these methods, including Transaction and Locking Support. These implementations will not be optimal but they will work.

Pleae note that there may be a better place for you to start out from, (like JDBCDataStore).


author:
   jgarnett


Field Summary
final protected static  LoggerLOGGER
     The logger for the filter module.
final protected  booleanisWriteable
     Flags AbstractDataStore to allow Modification.
public  FeatureListenerManagerlistenerManager
    

Constructor Summary
public  AbstractDataStore()
    
public  AbstractDataStore(boolean isWriteable)
     AbstractDataStore creation.
Parameters:
  isWriteable - true for writeable DataStore.

Method Summary
protected  FeatureWritercreateFeatureWriter(String typeName, Transaction transaction)
     Subclass should implement this to provide writing support.

A feature writer writes to the resource so it should considered to always be committing. The transaction is passed in so that it can be known what FeatureListeners should be notified of the changes.

protected  InProcessLockingManagercreateLockingManager()
     Currently returns an InProcessLockingManager.
protected  MapcreateMetadata(String typeName)
     Subclass override to provide access to metadata.
public  voidcreateSchema(FeatureType featureType)
     Subclass should implement to provide writing support.
public  voiddispose()
     Dummy implementation, it's a no-op.
protected  EnvelopegetBounds(Query query)
     Computes the bounds of the features for the specified feature type that satisfy the query provided that there is a fast way to get that result.

Will return null if there is not fast way to compute the bounds.

protected  intgetCount(Query query)
     Gets the number of the features that would be returned by this query for the specified feature type.

If getBounds(Query) returns -1 due to expense consider using getFeatures(Query).getCount() as a an alternative.


Parameters:
  query - Contains the Filter and MaxFeatures to find the bounds for.
abstract protected  FeatureReadergetFeatureReader(String typeName)
     Subclass must implement.
public  FeatureReadergetFeatureReader(Query query, Transaction transaction)
    
protected  FeatureReadergetFeatureReader(String typeName, Query query)
     GR: this method is called from inside getFeatureReader(Query ,Transaction ) to allow subclasses return an optimized FeatureReader wich supports the filter and attributes truncation specified in query

A subclass that supports the creation of such an optimized FeatureReader shold override this method.

public  FeatureSourcegetFeatureSource(String typeName)
     Default implementation based on getFeatureReader and getFeatureWriter.
protected  FeatureWritergetFeatureWriter(String typeName)
     Subclass can implement this to provide writing support.
public  FeatureWritergetFeatureWriter(String typeName, Filter filter, Transaction transaction)
    
public  FeatureWritergetFeatureWriter(String typeName, Transaction transaction)
    
public  FeatureWritergetFeatureWriterAppend(String typeName, Transaction transaction)
    
public  LockingManagergetLockingManager()
     Locking manager used for this DataStore.
abstract public  FeatureTypegetSchema(String typeName)
    
protected  SetgetSupportedHints()
     If you are using the automated FeatureSource/Store/Locking creation, this method allows for the specification of the supported hints.
abstract public  String[]getTypeNames()
    
protected  FiltergetUnsupportedFilter(String typeName, Filter filter)
     GR: if a subclass supports filtering, it should override this method to return the unsupported part of the passed filter, so a FilteringFeatureReader will be constructed upon it.
public  FeatureSourcegetView(Query query)
    
 TransactionStateDiffstate(Transaction transaction)
    
public  voidupdateSchema(String typeName, FeatureType featureType)
    

Field Detail
LOGGER
final protected static Logger LOGGER(Code)
The logger for the filter module.



isWriteable
final protected boolean isWriteable(Code)
Flags AbstractDataStore to allow Modification.

GetFeatureSource will return a FeatureStore is this is true.




listenerManager
public FeatureListenerManager listenerManager(Code)
Manages listener lists for FeatureSource implementation




Constructor Detail
AbstractDataStore
public AbstractDataStore()(Code)
Default (Writeable) DataStore



AbstractDataStore
public AbstractDataStore(boolean isWriteable)(Code)
AbstractDataStore creation.
Parameters:
  isWriteable - true for writeable DataStore.




Method Detail
createFeatureWriter
protected FeatureWriter createFeatureWriter(String typeName, Transaction transaction) throws IOException(Code)
Subclass should implement this to provide writing support.

A feature writer writes to the resource so it should considered to always be committing. The transaction is passed in so that it can be known what FeatureListeners should be notified of the changes. If the Transaction is AUTOCOMMIT then all listeners should be notified. If not all listeners that are NOT registered with that transaction should be notified.


Parameters:
  typeName -
Parameters:
  transaction - a feature writer FeatureWriter over contents of typeName
throws:
  IOException -
throws:
  IOException - Subclass may throw IOException
throws:
  UnsupportedOperationException - Subclass may implement




createLockingManager
protected InProcessLockingManager createLockingManager()(Code)
Currently returns an InProcessLockingManager.

Subclasses that implement real locking may override this method to return null.

InProcessLockingManager or null.



createMetadata
protected Map createMetadata(String typeName)(Code)
Subclass override to provide access to metadata.

CreateTypeEntry uses this method to aquire metadata information, if available.




createSchema
public void createSchema(FeatureType featureType) throws IOException(Code)
Subclass should implement to provide writing support.
Parameters:
  featureType - Requested FeatureType
throws:
  IOException -
throws:
  IOException - Subclass may throw IOException
throws:
  UnsupportedOperationException - Subclass may implement



dispose
public void dispose()(Code)
Dummy implementation, it's a no-op. Subclasses holding to system resources must override this method and release them.



getBounds
protected Envelope getBounds(Query query) throws IOException(Code)
Computes the bounds of the features for the specified feature type that satisfy the query provided that there is a fast way to get that result.

Will return null if there is not fast way to compute the bounds. Since it's based on some kind of header/cached information, it's not guaranteed to be real bound of the features


Parameters:
  query - the bounds, or null if too expensive
throws:
  SchemaNotFoundException -
throws:
  IOException -



getCount
protected int getCount(Query query) throws IOException(Code)
Gets the number of the features that would be returned by this query for the specified feature type.

If getBounds(Query) returns -1 due to expense consider using getFeatures(Query).getCount() as a an alternative.


Parameters:
  query - Contains the Filter and MaxFeatures to find the bounds for. The number of Features provided by the Query or -1if count is too expensive to calculate or any errors or occur.
throws:
  IOException -
throws:
  IOException - if there are errors getting the count



getFeatureReader
abstract protected FeatureReader getFeatureReader(String typeName) throws IOException(Code)
Subclass must implement.
Parameters:
  typeName - FeatureReader over contents of typeName



getFeatureReader
public FeatureReader getFeatureReader(Query query, Transaction transaction) throws IOException(Code)



getFeatureReader
protected FeatureReader getFeatureReader(String typeName, Query query) throws IOException(Code)
GR: this method is called from inside getFeatureReader(Query ,Transaction ) to allow subclasses return an optimized FeatureReader wich supports the filter and attributes truncation specified in query

A subclass that supports the creation of such an optimized FeatureReader shold override this method. Otherwise, it just returns getFeatureReader(typeName)




getFeatureSource
public FeatureSource getFeatureSource(String typeName) throws IOException(Code)
Default implementation based on getFeatureReader and getFeatureWriter.

We should be able to optimize this to only get the RowSet once


See Also:   org.geotools.data.DataStore.getFeatureSource(java.lang.String)



getFeatureWriter
protected FeatureWriter getFeatureWriter(String typeName) throws IOException(Code)
Subclass can implement this to provide writing support.
Parameters:
  typeName - FeatureWriter over contents of typeName
throws:
  IOException -
throws:
  IOException - Subclass may throw IOException
throws:
  UnsupportedOperationException - Subclass may implement



getFeatureWriter
public FeatureWriter getFeatureWriter(String typeName, Filter filter, Transaction transaction) throws IOException(Code)



getFeatureWriter
public FeatureWriter getFeatureWriter(String typeName, Transaction transaction) throws IOException(Code)



getFeatureWriterAppend
public FeatureWriter getFeatureWriterAppend(String typeName, Transaction transaction) throws IOException(Code)



getLockingManager
public LockingManager getLockingManager()(Code)
Locking manager used for this DataStore.

By default AbstractDataStore makes use of InProcessLockingManager.


See Also:   org.geotools.data.DataStore.getLockingManager



getSchema
abstract public FeatureType getSchema(String typeName) throws IOException(Code)
Retrive schema information for typeName



getSupportedHints
protected Set getSupportedHints()(Code)
If you are using the automated FeatureSource/Store/Locking creation, this method allows for the specification of the supported hints.



getTypeNames
abstract public String[] getTypeNames() throws IOException(Code)
Convience method for retriving all the names from the Catalog Entires



getUnsupportedFilter
protected Filter getUnsupportedFilter(String typeName, Filter filter)(Code)
GR: if a subclass supports filtering, it should override this method to return the unsupported part of the passed filter, so a FilteringFeatureReader will be constructed upon it. Otherwise it will just return the same filter.

If the complete filter is supported, the subclass must return Filter.INCLUDE




getView
public FeatureSource getView(Query query) throws IOException, SchemaException(Code)



state
TransactionStateDiff state(Transaction transaction)(Code)



updateSchema
public void updateSchema(String typeName, FeatureType featureType)(Code)



Methods inherited from java.lang.Object
native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.