Java Doc for VPFFile.java in  » GIS » GeoTools-2.4.1 » org » geotools » data » vpf » file » 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.vpf.file   Source Cross Reference   Class Diagram   Java Document (Java Doc)   java.lang.Object    org.geotools.data.vpf.file.VPFFile VPFFile public class VPFFile implements FeatureType,FileConstants,DataTypesDefinition(Code) This class encapsulates VPF files. By implementing the FeatureType interface, it serves as a factory for VPFColumns. Instances of this class should be created by VPFFileFactory. author:    Jeff Yutzler Constructor Summary public   VPFFile(String cPathName)      Constructor. Method Summary public  void close()      public  Feature create(Object[] attributes)      Create a new feature from the provided attributes It is unclear why one would want to use this method. public  Feature create(Object[] attributes, String featureID)      public  Feature duplicate(Feature feature)      public  int find(AttributeType type)      public  int find(String attName)      public  FeatureType[] getAncestors()      public  int getAttributeCount()      public  AttributeType getAttributeType(int position)      public  AttributeType getAttributeType(String xPath)      public  AttributeType[] getAttributeTypes()      public  char getByteOrder()      Gets the value of byteOrder variable. public  GeometryAttributeType getDefaultGeometry()      public  String getDescription()      Gets the value of the description of table content. public  String getDirectoryName()      Returns the directory name for this file by chopping off the file name and the separator. public  String getFileName()      public  URI getNamespace()      public  String getNarrativeTable()      Gets the value of narrativeTable variable file name. public  String getPathName()      protected  int getRecordSize()      Method getRecordSize is used to return size in bytes of records stored in this table. public  Feature getRowFromId(String idName, int id)      public  String getTypeName()      public  boolean hasAttributeType(String xPath)      public  boolean hasNext()      Determines if the stream contains storage for another object. public  boolean isAbstract()      public  boolean isDescendedFrom(FeatureType type)      public  boolean isDescendedFrom(URI nsURI, String typeName)      public  AbstractList readAllRows()      protected  char readChar()      protected  double readDouble()      public  Feature readFeature()      protected  Object readFixedSizeData(char dataType, int instancesCount)      Retrieves a fixed amount of data from the file Parameters:   dataType - a char value indicating the data type Parameters:   instancesCount - an int value indicating the number of instances to retrieve. protected  float readFloat()      Retrieves a floating point number from the file. protected  Object readGeometry(int instancesCount, int dimensionality, boolean readDoubles)      Constructs an object which is an instance of Geometry by reading values from the file. protected  void readHeader()      protected  int readInteger()      protected  byte[] readNumber(int cnt)      protected  short readShort()      protected  String readString(String terminators)      protected  TripletId readTripletId()      protected  Object readVariableSizeData(char dataType)      public  void reset()      Resets the file stream by setting its pointer to the first position after the header. protected  void setPosition(long pos)      public  String toString()      protected  void unread(long bytes)      Constructor Detail VPFFile public VPFFile(String cPathName) throws IOException, SchemaException(Code) Constructor. Parameters:   cPathName - The path to this file throws:   IOException - if the path or the file are invalid throws:   SchemaException - if the contained feature type can not beconstructed Method Detail close public void close() throws IOException(Code) Close the input stream pointed to by the object throws:   IOException - in some unlikely situation create public Feature create(Object[] attributes) throws IllegalAttributeException(Code) Create a new feature from the provided attributes It is unclear why one would want to use this method. Parameters:   attributes - the attributes to used the created feature throws:   IllegalAttributeException - if any of the attributes is invalid create public Feature create(Object[] attributes, String featureID) throws IllegalAttributeException(Code) duplicate public Feature duplicate(Feature feature) throws IllegalAttributeException(Code) find public int find(AttributeType type)(Code) find public int find(String attName)(Code) getAncestors public FeatureType[] getAncestors()(Code) getAttributeCount public int getAttributeCount()(Code) getAttributeType public AttributeType getAttributeType(int position)(Code) getAttributeType public AttributeType getAttributeType(String xPath)(Code) getAttributeTypes public AttributeType[] getAttributeTypes()(Code) getByteOrder public char getByteOrder()(Code) Gets the value of byteOrder variable. Byte order in which table is written: L - least-significant-first M - most-significant-first the value of byteOrder getDefaultGeometry public GeometryAttributeType getDefaultGeometry()(Code) getDescription public String getDescription()(Code) Gets the value of the description of table content. This is nice to have, but I don't know how to make use of it. the value of description getDirectoryName public String getDirectoryName()(Code) Returns the directory name for this file by chopping off the file name and the separator. the directory name for this file getFileName public String getFileName()(Code) Returns the file name (without path) for the file the file name for this file getNamespace public URI getNamespace()(Code) getNarrativeTable public String getNarrativeTable()(Code) Gets the value of narrativeTable variable file name. the value of narrativeTable getPathName public String getPathName()(Code) Gets the full path name for this file the path name for this file getRecordSize protected int getRecordSize()(Code) Method getRecordSize is used to return size in bytes of records stored in this table. If table keeps variable length records -1 should be returned. an int value getRowFromId public Feature getRowFromId(String idName, int id) throws IllegalAttributeException(Code) Returns a row with a matching value for the provided column Parameters:   idName - The name of the column to look for, such as "id" Parameters:   id - An identifier for the requested row The first row which matches the ID throws:   IllegalAttributeException - The feature can not be created due toillegal attributes in the source file getTypeName public String getTypeName()(Code) hasAttributeType public boolean hasAttributeType(String xPath)(Code) hasNext public boolean hasNext()(Code) Determines if the stream contains storage for another object. Who knows how well this will work on variable length objects? a boolean isAbstract public boolean isAbstract()(Code) isDescendedFrom public boolean isDescendedFrom(FeatureType type)(Code) isDescendedFrom public boolean isDescendedFrom(URI nsURI, String typeName)(Code) readAllRows public AbstractList readAllRows() throws IOException(Code) Generates a list containing all of the features in the file a List value containing Feature objects exception:   IOException - if an error occurs readChar protected char readChar() throws IOException(Code) Reads a single byte as a character value a char value exception:   IOException - if an error occurs readDouble protected double readDouble() throws IOException(Code) Retrieves a double from the file a double value exception:   IOException - if an error occurs readFeature public Feature readFeature() throws IOException, IllegalAttributeException(Code) Retrieves a feature from the file the retieved feature throws:   IOException - on any file IO errors throws:   IllegalAttributeException - if any of the attributes retrieved areillegal readFixedSizeData protected Object readFixedSizeData(char dataType, int instancesCount) throws IOException(Code) Retrieves a fixed amount of data from the file Parameters:   dataType - a char value indicating the data type Parameters:   instancesCount - an int value indicating the number of instances to retrieve. an Object value exception:   IOException - if an error occurs readFloat protected float readFloat() throws IOException(Code) Retrieves a floating point number from the file. a float value exception:   IOException - if an error occurs readGeometry protected Object readGeometry(int instancesCount, int dimensionality, boolean readDoubles) throws IOException(Code) Constructs an object which is an instance of Geometry by reading values from the file. Parameters:   instancesCount - number of coordinates to read Parameters:   dimensionality - either 2 or 3 Parameters:   readDoubles - true: read a double value; false: read a float value the constructed object throws:   IOException - on any file IO errors readHeader protected void readHeader() throws VPFHeaderFormatException, IOException(Code) Retrieves a number of attributes from the file header exception:   VPFHeaderFormatException - if an error occurs exception:   IOException - if an error occurs readInteger protected int readInteger() throws IOException(Code) Retrieves an integer value from the file an int value exception:   IOException - if an error occurs readNumber protected byte[] readNumber(int cnt) throws IOException(Code) Reads some byte data from the file Parameters:   cnt - an int value indicating the number of bytes to retrieve a byte[] value throws:   IOException - if an error occurs readShort protected short readShort() throws IOException(Code) Retrieves a short value from the file a short value exception:   IOException - if an error occurs readString protected String readString(String terminators) throws IOException(Code) Reads a string value from the file Parameters:   terminators - a String value indicating the terminators to look for a String value exception:   IOException - if an error occurs readTripletId protected TripletId readTripletId() throws IOException(Code) Retrieves a triplet object from the file a TripletId value throws:   IOException - on any IO errors readVariableSizeData protected Object readVariableSizeData(char dataType) throws IOException(Code) Retrieves variable sized data from the file by first reading an integer which indicates how many instances of the data type to retrieve Parameters:   dataType - a char value indicating the data type an Object value exception:   IOException - if an error occurs reset public void reset()(Code) Resets the file stream by setting its pointer to the first position after the header. setPosition protected void setPosition(long pos) throws IOException(Code) Sets the position in the stream Parameters:   pos - A 1-indexed position throws:   IOException - on any IO failures toString public String toString()(Code) unread protected void unread(long bytes) throws IOException(Code) Back up a specified number of bytes in the file stream Parameters:   bytes - a long value exception:   IOException - if an error occurs 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)