- java.lang.Object
-
- org.arakhne.afc.io.shape.AbstractCommonShapeFileWriter<E>
-
- org.arakhne.afc.io.shape.AbstractShapeFileWriter<E>
-
- org.arakhne.afc.io.shape.ShapeFileWriter<E>
-
- Type Parameters:
E
- is the type of element to write inside the ESRI shape file.
- All Implemented Interfaces:
AutoCloseable
public class ShapeFileWriter<E> extends AbstractShapeFileWriter<E>
This class permits to write an ESRI Shape file.The specification of the ESRI Shape file format is described in the July 98 specification document.
- Since:
- 14.0
- Version:
- 17.0 2020-01-04 14:41:52
- Author:
- Stéphane GALLAND, Olivier LAMOTTE
- Maven Group Id:
- org.arakhne.afc.advanced
- Maven Artifact Id:
- shapefile
-
-
Field Summary
-
Fields inherited from class org.arakhne.afc.io.shape.AbstractCommonShapeFileWriter
BLOCK_SIZE
-
-
Constructor Summary
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected AttributeProvider
getAttributeProvider(E element)
Replies the attribute container of the given element.protected AttributeProvider[]
getAttributeProviders(Collection<? extends E> elements)
Replies all the attribute containers of the given elements.protected ESRIBounds
getFileBounds()
Invoked to retrieve the bounds of the world.protected int
getGroupCountFor(E element)
Replies the count of groups of points.protected ShapeMultiPatchType
getGroupTypeFor(E element, int groupIndex)
Replies the type of the given part for a multipatch element.protected ESRIPoint
getPointAt(E element, int groupIndex, int pointIndex, boolean expectM, boolean expectZ)
Replies the point inside the given part at the given index.protected int
getPointCountFor(E element, int groupIndex)
Replies the count of points inside the given part.-
Methods inherited from class org.arakhne.afc.io.shape.AbstractShapeFileWriter
close, onHeaderWritten, writeElement
-
Methods inherited from class org.arakhne.afc.io.shape.AbstractCommonShapeFileWriter
ensureAvailableBytes, flush, getElementType, getTaskProgression, isHeaderWritten, setTaskProgression, write, write, writeBEDouble, writeBEInt, writeLEDouble, writeLEInt
-
-
-
-
Constructor Detail
-
ShapeFileWriter
public ShapeFileWriter(File shapeName, ShapeElementType elementType, ElementExporter<E> exporter) throws IOException
Constructor.- Parameters:
shapeName
- is the file to writeelementType
- is the type of the elements to write.exporter
- is the exporter object which will invoked to retrieve element data.- Throws:
IOException
- in case of error.
-
ShapeFileWriter
public ShapeFileWriter(URL shapeName, ShapeElementType elementType, ElementExporter<E> exporter) throws IOException
Constructor.- Parameters:
shapeName
- is the file to writeelementType
- is the type of the elements to write.exporter
- is the exporter object which will invoked to retrieve element data.- Throws:
IOException
- in case of error.
-
ShapeFileWriter
public ShapeFileWriter(OutputStream stream, ShapeElementType elementType, ElementExporter<E> exporter) throws IOException
Constructor.- Parameters:
stream
- is the file to writeelementType
- is the type of the elements to write.exporter
- is the exporter object which will invoked to retrieve element data.- Throws:
IOException
- in case of error.
-
ShapeFileWriter
public ShapeFileWriter(WritableByteChannel channel, ShapeElementType elementType, ElementExporter<E> exporter) throws IOException
Constructor.- Parameters:
channel
- is the file to writeelementType
- is the type of the elements to write.exporter
- is the exporter object which will invoked to retrieve element data.- Throws:
IOException
- in case of error.
-
ShapeFileWriter
public ShapeFileWriter(File shapeName, ShapeElementType elementType, ElementExporter<E> exporter, ShapeFileIndexWriter shxWriter) throws IOException
Constructor.- Parameters:
shapeName
- is the file to writeelementType
- is the type of the elements to write.exporter
- is the exporter object which will invoked to retrieve element data.shxWriter
- is the writer used to create the index- Throws:
IOException
- in case of error.
-
ShapeFileWriter
public ShapeFileWriter(URL shapeName, ShapeElementType elementType, ElementExporter<E> exporter, ShapeFileIndexWriter shxWriter) throws IOException
Constructor.- Parameters:
shapeName
- is the file to writeelementType
- is the type of the elements to write.exporter
- is the exporter object which will invoked to retrieve element data.shxWriter
- is the writer used to create the index- Throws:
IOException
- in case of error.
-
ShapeFileWriter
public ShapeFileWriter(OutputStream stream, ShapeElementType elementType, ElementExporter<E> exporter, ShapeFileIndexWriter shxWriter) throws IOException
Constructor.- Parameters:
stream
- is the file to writeelementType
- is the type of the elements to write.exporter
- is the exporter object which will invoked to retrieve element data.shxWriter
- is the writer used to create the index- Throws:
IOException
- in case of error.
-
ShapeFileWriter
public ShapeFileWriter(WritableByteChannel channel, ShapeElementType elementType, ElementExporter<E> exporter, ShapeFileIndexWriter shxWriter) throws IOException
Constructor.- Parameters:
channel
- is the file to writeelementType
- is the type of the elements to write.exporter
- is the exporter object which will invoked to retrieve element data.shxWriter
- is the writer used to create the index- Throws:
IOException
- in case of error.
-
ShapeFileWriter
public ShapeFileWriter(File shapeName, ShapeElementType elementType, ElementExporter<E> exporter, DBaseFileWriter dbfWriter) throws IOException
Constructor.- Parameters:
shapeName
- is the file to writeelementType
- is the type of the elements to write.exporter
- is the exporter object which will invoked to retrieve element data.dbfWriter
- is the writer used to export the attributes- Throws:
IOException
- in case of error.
-
ShapeFileWriter
public ShapeFileWriter(URL shapeName, ShapeElementType elementType, ElementExporter<E> exporter, DBaseFileWriter dbfWriter) throws IOException
Constructor.- Parameters:
shapeName
- is the file to writeelementType
- is the type of the elements to write.exporter
- is the exporter object which will invoked to retrieve element data.dbfWriter
- is the writer used to export the attributes- Throws:
IOException
- in case of error.
-
ShapeFileWriter
public ShapeFileWriter(OutputStream stream, ShapeElementType elementType, ElementExporter<E> exporter, DBaseFileWriter dbfWriter) throws IOException
Constructor.- Parameters:
stream
- is the file to writeelementType
- is the type of the elements to write.exporter
- is the exporter object which will invoked to retrieve element data.dbfWriter
- is the writer used to export the attributes- Throws:
IOException
- in case of error.
-
ShapeFileWriter
public ShapeFileWriter(WritableByteChannel channel, ShapeElementType elementType, ElementExporter<E> exporter, DBaseFileWriter dbfWriter) throws IOException
Constructor.- Parameters:
channel
- is the file to writeelementType
- is the type of the elements to write.exporter
- is the exporter object which will invoked to retrieve element data.dbfWriter
- is the writer used to export the attributes- Throws:
IOException
- in case of error.
-
ShapeFileWriter
public ShapeFileWriter(File shapeName, ShapeElementType elementType, ElementExporter<E> exporter, DBaseFileWriter dbfWriter, ShapeFileIndexWriter shxWriter) throws IOException
Constructor.- Parameters:
shapeName
- is the file to writeelementType
- is the type of the elements to write.exporter
- is the exporter object which will invoked to retrieve element data.dbfWriter
- is the writer used to export the attributesshxWriter
- is the writer used to create the index- Throws:
IOException
- in case of error.
-
ShapeFileWriter
public ShapeFileWriter(URL shapeName, ShapeElementType elementType, ElementExporter<E> exporter, DBaseFileWriter dbfWriter, ShapeFileIndexWriter shxWriter) throws IOException
Constructor.- Parameters:
shapeName
- is the file to writeelementType
- is the type of the elements to write.exporter
- is the exporter object which will invoked to retrieve element data.dbfWriter
- is the writer used to export the attributesshxWriter
- is the writer used to create the index- Throws:
IOException
- in case of error.
-
ShapeFileWriter
public ShapeFileWriter(OutputStream stream, ShapeElementType elementType, ElementExporter<E> exporter, DBaseFileWriter dbfWriter, ShapeFileIndexWriter shxWriter) throws IOException
Constructor.- Parameters:
stream
- is the file to writeelementType
- is the type of the elements to write.exporter
- is the exporter object which will invoked to retrieve element data.dbfWriter
- is the writer used to export the attributesshxWriter
- is the writer used to create the index- Throws:
IOException
- in case of error.
-
ShapeFileWriter
public ShapeFileWriter(WritableByteChannel channel, ShapeElementType elementType, ElementExporter<E> exporter, DBaseFileWriter dbfWriter, ShapeFileIndexWriter shxWriter) throws IOException
Constructor.- Parameters:
channel
- is the file to writeelementType
- is the type of the elements to write.exporter
- is the exporter object which will invoked to retrieve element data.dbfWriter
- is the writer used to export the attributesshxWriter
- is the writer used to create the index- Throws:
IOException
- in case of error.
-
-
Method Detail
-
getAttributeProviders
protected AttributeProvider[] getAttributeProviders(Collection<? extends E> elements) throws IOException
Description copied from class:AbstractShapeFileWriter
Replies all the attribute containers of the given elements. The attributes will be put in a DBase file header as columns. The size of the replied array should be the same as the size of the collection of elements. Otherwise you must be sure that you are not loosing attributes. Moreover the position of the AttributeProvider in the array must corresponds to the position of the element record in the DBF and shape file.- Specified by:
getAttributeProviders
in classAbstractShapeFileWriter<E>
- Parameters:
elements
- are the element from which the attribute containers must be extracted- Returns:
- the attribute containers.
- Throws:
IOException
- in case of error.
-
getAttributeProvider
protected AttributeProvider getAttributeProvider(E element) throws IOException
Description copied from class:AbstractShapeFileWriter
Replies the attribute container of the given element. The attributes will be put in a DBase file.- Specified by:
getAttributeProvider
in classAbstractShapeFileWriter<E>
- Parameters:
element
- is the element from which the attribute container must be extracted- Returns:
- the attribute container
- Throws:
IOException
- in case of error.
-
getGroupCountFor
protected int getGroupCountFor(E element) throws IOException
Description copied from class:AbstractShapeFileWriter
Replies the count of groups of points.- Specified by:
getGroupCountFor
in classAbstractShapeFileWriter<E>
- Parameters:
element
- is the element from which the group count must be extracted- Returns:
- the count of groups of points.
- Throws:
IOException
- in case of error.
-
getPointAt
protected ESRIPoint getPointAt(E element, int groupIndex, int pointIndex, boolean expectM, boolean expectZ) throws IOException
Description copied from class:AbstractShapeFileWriter
Replies the point inside the given part at the given index.This function is also invoked for a simple point. In this case, the group and point indexes are both equal to zero. This function is also invoked for a multipoint. In this case, the group index is always equal to zero.
- Specified by:
getPointAt
in classAbstractShapeFileWriter<E>
- Parameters:
element
- is the element from which the point must be extractedgroupIndex
- is the index of the group from which the point must be extracted.pointIndex
- is the index of the point in the group.expectM
- indicates if the M value is expected.expectZ
- indicates if the Z value is expected.- Returns:
- the point.
- Throws:
IOException
- in case of error.
-
getPointCountFor
protected int getPointCountFor(E element, int groupIndex) throws IOException
Description copied from class:AbstractShapeFileWriter
Replies the count of points inside the given part. This function is also invoked for a multipoint. In this case, the group index is always equal to zero.- Specified by:
getPointCountFor
in classAbstractShapeFileWriter<E>
- Parameters:
element
- is the element from which the point count must be extractedgroupIndex
- is the index of the group from which the point count must be replied.- Returns:
- the count of points in the part at the given index.
- Throws:
IOException
- in case of error.
-
getGroupTypeFor
protected ShapeMultiPatchType getGroupTypeFor(E element, int groupIndex) throws IOException
Description copied from class:AbstractShapeFileWriter
Replies the type of the given part for a multipatch element.A MultiPatch consists of a number of surface patches. Each surface patch describes a surface. The surface patches of a MultiPatch are referred to as its parts, and the type of part controls how the order of vertices of an MultiPatch part is interpreted.
A single Triangle Strip, or Triangle Fan, represents a single surface patch.
A sequence of parts that are rings can describe a polygonal surface patch with holes. The sequence typically consists of an Outer Ring, representing the outer boundary of the patch, followed by a number of Inner Rings representing holes. When the individual types of rings in a collection of rings representing a polygonal patch with holes are unknown, the sequence must start with First Ring, followed by a number of Rings. A sequence of Rings not preceded by an First Ring is treated as a sequence of Outer Rings without holes.
- Specified by:
getGroupTypeFor
in classAbstractShapeFileWriter<E>
- Parameters:
element
- is the element from which the point count must be extractedgroupIndex
- is the index of the group from which the point count must be replied.- Returns:
- the type of the part.
- Throws:
IOException
- in case of error.
-
getFileBounds
protected ESRIBounds getFileBounds()
Description copied from class:AbstractCommonShapeFileWriter
Invoked to retrieve the bounds of the world.- Specified by:
getFileBounds
in classAbstractCommonShapeFileWriter<E>
- Returns:
- the bounds.
-
-