Directory (Groovy Documentation)

geoscript.workspace.Directory

A Directory Workspace can contain one or more Shapefiles.

 Directory dir = new Directory("shapefiles")
 Layer layer = dir.get("states")

Authors:: Jared Erickson

Nested Class Summary

Nested classes
Modifiers	Name	Description
`static class`	`Directory.Factory`	The Directory WorkspaceFactory

Constructor Summary

Constructors
Constructor and description
`Directory (java.io.File dir)` Create a Directory Workspace from a File directory
`Directory (java.lang.String dir)` Create a Directory Workspace from a File directory
`Directory (org.geotools.data.directory.DirectoryDataStore ds)` Create a Directory Workspace from a GeoTools DirectoryDataStore
`Directory (org.geotools.data.shapefile.ShapefileDataStore ds)` Create a Directory Workspace from a GeoTools ShapefileDataStore

Methods Summary

Methods
Type	Name and description
`static Directory`	`fromURL(java.util.Map options = [:], java.net.URL url, java.io.File dir)` Get a Directory from a zipped Shapefile
`Layer`	`get(java.lang.String name)` Get a Layer by name
`java.io.File`	`getFile()` Get the File or Directory
`java.lang.String`	`getFormat()` Get the format
`void`	`remove(java.lang.String name)` Remove a Layer by name from this Workspace
`java.lang.String`	`toString()` The string representation

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class Workspace`	`add, add, close, create, create, get, getAt, getFormat, getLayers, getNames, getParameters, getWorkspace, getWorkspace, getWorkspaceNames, getWorkspaceParameters, has, readFeatures, remove, remove, withWorkspace, withWorkspace, withWorkspace, wrap`
`class java.lang.Object`	`java.lang.Object#wait(long, int), java.lang.Object#wait(long), java.lang.Object#wait(), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll()`

- Constructor Detail
  - Directory(java.io.File dir)
    
    Create a Directory Workspace from a File directory
    Parameters:
    dir - The File directory
  - Directory(java.lang.String dir)
    
    Create a Directory Workspace from a File directory
    Parameters:
    dir - The File directory as a String
  - Directory(org.geotools.data.directory.DirectoryDataStore ds)
    
    Create a Directory Workspace from a GeoTools DirectoryDataStore
    Parameters:
    ds - The GeoTools DirectoryDataStore
  - Directory(org.geotools.data.shapefile.ShapefileDataStore ds)
    
    Create a Directory Workspace from a GeoTools ShapefileDataStore
    Parameters:
    ds - The GeoTools ShapefileDataStore
- Method Detail
  - static Directory fromURL(java.util.Map options = [:], java.net.URL url, java.io.File dir)
    
    Get a Directory from a zipped Shapefile
    Returns:
    A Directory Workspace
    Parameters:
    options - Optional named parameters:
    
    overwrite = Whether to overwrite the existing file or not (defaults to true)
    url - The URL of the zipped Shapefile
    dir - The File directory where we will unzip the zip file
  - @java.lang.Override Layer get(java.lang.String name)
    
    Get a Layer by name
    Returns:
    A Layer
    Parameters:
    The - Layer name
  - java.io.File getFile()
    
    Get the File or Directory
    Returns:
    The File or Directory
  - java.lang.String getFormat()
    
    Get the format
    Returns:
    The workspace format name
  - @java.lang.Override void remove(java.lang.String name)
    
    Remove a Layer by name from this Workspace
    Parameters:
    name - The Layer name
  - java.lang.String toString()
    
    The string representation
    Returns:
    The string representation

Summary:
Nested
Constructor
Method

| Detail:
Constructor
Method

Groovy Documentation

[Groovy] Class Directory

Nested Class Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Constructor Detail

Directory(java.io.File dir)

Directory(java.lang.String dir)

Directory(org.geotools.data.directory.DirectoryDataStore ds)

Directory(org.geotools.data.shapefile.ShapefileDataStore ds)

Method Detail

static Directory fromURL(java.util.Map options = [:], java.net.URL url, java.io.File dir)

@java.lang.Override Layer get(java.lang.String name)

java.io.File getFile()

java.lang.String getFormat()

@java.lang.Override void remove(java.lang.String name)

java.lang.String toString()