Module org.arakhne.afc.advanced.shapefile
Package org.arakhne.afc.io.shape

Class AbstractShapeFileWriter<E>

    • Constructor Detail

      • AbstractShapeFileWriter

        public AbstractShapeFileWriter​(File shapeName,
                               ShapeElementType elementType,
                               DBaseFileWriter dbfWriter,
                               ShapeFileIndexWriter shxWriter)
                        throws IOException
        Constructor.
        Parameters:
        shapeName - is the file to write
        elementType - is the type of the elements to write.
        dbfWriter - is the writer used to export the attributes
        shxWriter - is the writer used to create the index
        Throws:
        IOException - in case of error.

      • AbstractShapeFileWriter

        public AbstractShapeFileWriter​(URL shapeName,
                               ShapeElementType elementType,
                               DBaseFileWriter dbfWriter,
                               ShapeFileIndexWriter shxWriter)
                        throws IOException
        Constructor.
        Parameters:
        shapeName - is the file to write
        elementType - is the type of the elements to write.
        dbfWriter - is the writer used to export the attributes
        shxWriter - is the writer used to create the index
        Throws:
        IOException - in case of error.

      • AbstractShapeFileWriter

        public AbstractShapeFileWriter​(OutputStream stream,
                               ShapeElementType elementType,
                               DBaseFileWriter dbfWriter,
                               ShapeFileIndexWriter shxWriter)
                        throws IOException
        Constructor.
        Parameters:
        stream - is the file to write
        elementType - is the type of the elements to write.
        dbfWriter - is the writer used to export the attributes
        shxWriter - is the writer used to create the index
        Throws:
        IOException - in case of error.

    • Method Detail

      • getPointCountFor

        protected abstract int getPointCountFor​(E element,
                                        int groupIndex)
                                 throws IOException
        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.
        Parameters:
        element - is the element from which the point count must be extracted
        groupIndex - 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 abstract ShapeMultiPatchType getGroupTypeFor​(E element,
                                                       int groupIndex)
                                                throws IOException
        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.

        Parameters:
        element - is the element from which the point count must be extracted
        groupIndex - 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.

      • getAttributeProviders

        protected abstract AttributeProvider[] getAttributeProviders​(Collection<? extends E> elements)
                                                      throws IOException
        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.
        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 abstract AttributeProvider getAttributeProvider​(E element)
                                                   throws IOException
        Replies the attribute container of the given element. The attributes will be put in a DBase file.
        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 abstract int getGroupCountFor​(E element)
                                 throws IOException
        Replies the count of groups of points.
        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 abstract ESRIPoint getPointAt​(E element,
                                        int groupIndex,
                                        int pointIndex,
                                        boolean expectM,
                                        boolean expectZ)
                                 throws IOException
        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.

        Parameters:
        element - is the element from which the point must be extracted
        groupIndex - 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.