Java Doc for ShapefileReader.java in  » GIS » GeoTools-2.4.1 » org » geotools » data » shapefile » shp » 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.shapefile.shp 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   org.geotools.data.shapefile.shp.ShapefileReader

ShapefileReader
public class ShapefileReader (Code)
The general use of this class is:
 FileChannel in = new FileInputStream("thefile.dbf").getChannel();
 ShapefileReader r = new ShapefileReader( in ) while (r.hasNext()) { Geometry
 shape = (Geometry) r.nextRecord().shape() // do stuff } r.close();
 
You don't have to immediately ask for the shape from the record. The record will contain the bounds of the shape and will only read the shape when the shape() method is called. This ShapefileReader.Record is the same object every time, so if you need data from the Record, be sure to copy it.
author:
   jamesm
author:
   aaime
author:
   Ian Schneider

Inner Class :final public class Record

Field Summary
 ByteBufferbuffer
    

Constructor Summary
public  ShapefileReader(ReadableByteChannel channel, boolean strict, boolean useMemoryMapped, Lock lock)
     Creates a new instance of ShapeFile.
public  ShapefileReader(ReadableByteChannel channel, Lock lock)
     Default constructor.

Method Summary
public  voidclose()
     Clean up any resources.
public static  ByteBufferensureCapacity(ByteBuffer buffer, int size, boolean useMemoryMappedBuffer)
    
public static  intfill(ByteBuffer buffer, ReadableByteChannel channel)
    
public  intgetCount(int count)
     Parses the shpfile counting the records.
public  ShapefileHeadergetHeader()
     Get the header.
public  voidgoTo(int offset)
    
public  booleanhasNext()
     If there exists another record.
public static  voidmain(String[] args)
    
public  RecordnextRecord()
     Fetch the next record information.
public static  ShapefileHeaderreadHeader(ReadableByteChannel channel, boolean strict)
     A short cut for reading the header from the given channel.
Parameters:
  channel - The channel to read from.
Parameters:
  strict - True to make the header parsing throw Exceptions if theversion or magic number are incorrect.
throws:
  IOException - If problems arise.
public  RecordrecordAt(int offset)
     Sets the current location of the byteStream to offset and returns the next record.
public  voidsetHandler(ShapeHandler handler)
    
public  ObjectshapeAt(int offset)
    
public  booleansupportsRandomAccess()
    
public  inttransferTo(ShapefileWriter writer, int recordNum, double[] bounds)
     Transfer (by bytes) the data at the current record to the ShapefileWriter.

Field Detail
buffer
ByteBuffer buffer(Code)




Constructor Detail
ShapefileReader
public ShapefileReader(ReadableByteChannel channel, boolean strict, boolean useMemoryMapped, Lock lock) throws IOException, ShapefileException(Code)
Creates a new instance of ShapeFile.
Parameters:
  channel - The ReadableByteChannel this reader will use.
Parameters:
  strict - True to make the header parsing throw Exceptions if theversion or magic number are incorrect.
throws:
  IOException - If problems arise.
throws:
  ShapefileException - If for some reason the file contains invalid records.



ShapefileReader
public ShapefileReader(ReadableByteChannel channel, Lock lock) throws IOException, ShapefileException(Code)
Default constructor. Calls ShapefileReader(channel,true).
Parameters:
  channel -
throws:
  IOException -
throws:
  ShapefileException -




Method Detail
close
public void close() throws IOException(Code)
Clean up any resources. Closes the channel.
throws:
  IOException - If errors occur while closing the channel.



ensureCapacity
public static ByteBuffer ensureCapacity(ByteBuffer buffer, int size, boolean useMemoryMappedBuffer)(Code)



fill
public static int fill(ByteBuffer buffer, ReadableByteChannel channel) throws IOException(Code)



getCount
public int getCount(int count) throws DataSourceException(Code)
Parses the shpfile counting the records. the number of non-null records in the shapefile



getHeader
public ShapefileHeader getHeader()(Code)
Get the header. Its parsed in the constructor. The header that is associated with this file.



goTo
public void goTo(int offset) throws IOException, UnsupportedOperationException(Code)
Needs better data, what is the requirements for offset?
Parameters:
  offset -
throws:
  IOException -
throws:
  UnsupportedOperationException -



hasNext
public boolean hasNext() throws IOException(Code)
If there exists another record. Currently checks the stream for the presence of 8 more bytes, the length of a record. If this is true and the record indicates the next logical record number, there exists more records.
throws:
  IOException - True if has next record, false otherwise.



main
public static void main(String[] args) throws Exception(Code)



nextRecord
public Record nextRecord() throws IOException(Code)
Fetch the next record information.
throws:
  IOException - The record instance associated with this reader.



readHeader
public static ShapefileHeader readHeader(ReadableByteChannel channel, boolean strict) throws IOException(Code)
A short cut for reading the header from the given channel.
Parameters:
  channel - The channel to read from.
Parameters:
  strict - True to make the header parsing throw Exceptions if theversion or magic number are incorrect.
throws:
  IOException - If problems arise. A ShapefileHeader object.



recordAt
public Record recordAt(int offset) throws IOException, UnsupportedOperationException(Code)
Sets the current location of the byteStream to offset and returns the next record. Usually used in conjuctions with the shx file or some other index file.
Parameters:
  offset - If using an shx file the offset would be: 2 *(index.getOffset(i)) The record after the offset location in the bytestream
throws:
  IOException - thrown in a read error occurs
throws:
  UnsupportedOperationException - thrown if not a random access file



setHandler
public void setHandler(ShapeHandler handler)(Code)

Parameters:
  handler - The handler to set.



shapeAt
public Object shapeAt(int offset) throws IOException, UnsupportedOperationException(Code)
TODO needs better java docs!!! What is offset?
Parameters:
  offset -
throws:
  IOException -
throws:
  UnsupportedOperationException -



supportsRandomAccess
public boolean supportsRandomAccess()(Code)



transferTo
public int transferTo(ShapefileWriter writer, int recordNum, double[] bounds) throws IOException(Code)
Transfer (by bytes) the data at the current record to the ShapefileWriter.
Parameters:
  bounds - double array of length four for transfering the bounds into The length of the record transfered in bytes



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.