|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.esri.arcgis.datasourcesfile.ShapefileWorkspaceFactory
public class ShapefileWorkspaceFactory
Esri Shapefile Workspace Factory.
Constructor Summary | |
---|---|
ShapefileWorkspaceFactory()
Constructs a ShapefileWorkspaceFactory using ArcGIS Engine. |
|
ShapefileWorkspaceFactory(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts. ShapefileWorkspaceFactory theShapefileWorkspaceFactory = (ShapefileWorkspaceFactory) obj; |
Method Summary | |
---|---|
boolean |
containsWorkspace(String parentDirectory,
IFileNames fileNames)
Indicates if parentDirectory contains a valid workspace, or is a valid file-system workspace. |
boolean |
copy(IWorkspaceName workspaceName,
String destinationFolder,
IWorkspaceName[] workspaceNameCopy)
Copies a workspace to the specified destination folder. |
IWorkspaceName |
create(String parentDirectory,
String name,
IPropertySet connectionProperties,
int hWnd)
Creates a new workspace specified by the directory, file name, and connection properties. |
boolean |
equals(Object o)
Compare this object with another |
IUID |
getClassID()
The class ID of the WorkspaceFactory. |
static String |
getClsid()
getClsid. |
String |
getWorkspaceDescription(boolean plural)
A singular or plural description of the type of workspace the workspace factory opens/creates. |
IWorkspaceName |
getWorkspaceName(String parentDirectory,
IFileNames fileNames)
Retrieves the workspace name of a workspace from the given list of file names. |
int |
getWorkspaceType()
The type of workspace the workspace factory opens/creates. |
int |
hashCode()
the hashcode for this object |
boolean |
isWorkspace(String fileName)
True if the specified file identifies a workspace supported by the workspace factory. |
boolean |
move(IWorkspaceName workspaceName,
String destinationFolder)
Moves a workspace to the specified destination folder. |
IWorkspace |
open(IPropertySet connectionProperties,
int hWnd)
Opens the workspace specified by the connection properties. |
IWorkspace |
openFromFile(String fileName,
int hWnd)
Opens the workspace specified by the given file name. |
IWorkspace |
openFromString(String connectStr,
int hWnd)
Opens the workspace specified by a connection string. |
IPropertySet |
readConnectionPropertiesFromFile(String fileName)
The connection properties from the specified file. |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef |
---|
getJintegraDispatch, release |
Constructor Detail |
---|
public ShapefileWorkspaceFactory() throws IOException, UnknownHostException
IOException
- if there are interop problems
UnknownHostException
- if there are interop problemspublic ShapefileWorkspaceFactory(Object obj) throws IOException
ShapefileWorkspaceFactory theShapefileWorkspaceFactory = (ShapefileWorkspaceFactory) obj;
obj
to ShapefileWorkspaceFactory
.
obj
- an object returned from ArcGIS Engine or Server
IOException
- if there are interop problemsMethod Detail |
---|
public static String getClsid()
public boolean equals(Object o)
equals
in class Object
public int hashCode()
hashCode
in class Object
public IWorkspace open(IPropertySet connectionProperties, int hWnd) throws IOException, AutomationException
Open takes as input a property set of connection properties that specify the workspace to connect to. In the case of file system workspaces and local database workspaces, a single property named DATABASE, whose value is the pathname to the workspace, is usually all that is required. In the case of remote database workspaces accessed via ArcSDE the properties can include the USER, PASSWORD, DATABASE, SERVER, INSTANCE, VERSION, HISTORICAL_NAME, HISTORICAL_TIMESTAMP, and AUTHENTICATION_MODE properties of the database being connected to.
List of acceptable connection property names and a brief description of each
"SERVER" – SDE server name you are connecting to.
"INSTANCE" – Instance you are connection to.
"DATABASE" – Database connected to.
"USER" – Connected user.
"PASSWORD" – Connected password.
"AUTHENTICATION_MODE" – Credential authentication mode of the connection. Acceptable values are "OSA" and "DBMS".
"VERSION" – Transactional version to connect to. Acceptable value is a string that represents a transaction version name.
"HISTORICAL_NAME" – Historical version to connect to. Acceptable value is a string type that represents a historical marker name.
"HISTORICAL_TIMESTAMP" – Moment in history to establish an historical version connection. Acceptable value is a date time that represents a moment timestamp.
Notes:
open
in interface IWorkspaceFactory
connectionProperties
- A reference to a com.esri.arcgis.system.IPropertySet (in)hWnd
- The hWnd (A COM typedef) (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IWorkspace openFromFile(String fileName, int hWnd) throws IOException, AutomationException
OpenFromFile takes the pathname of a file or directory that represents either a FileSystemWorkspace or LocalDatabaseWorkspace, or a connection file to a RemoteDatabase workspace and returns an interface on the specified workspace. Clients of these methods can then proceed to open and access datasets in the workspace. If these methods are called with insufficient properties, then the user will be presented with a connection dialog that will prompt for the required properties.
The hWnd argument is the parent window or application's window. The hWnd will guarantee that the connection dialog, if presented to you because of insufficient properties, has the correct parent.
openFromFile
in interface IWorkspaceFactory
fileName
- The fileName (in)hWnd
- The hWnd (A COM typedef) (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IWorkspaceName create(String parentDirectory, String name, IPropertySet connectionProperties, int hWnd) throws IOException, AutomationException
create
in interface IWorkspaceFactory
parentDirectory
- The parentDirectory (in)name
- The name (in)connectionProperties
- A reference to a com.esri.arcgis.system.IPropertySet (in)hWnd
- The hWnd (A COM typedef) (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean containsWorkspace(String parentDirectory, IFileNames fileNames) throws IOException, AutomationException
containsWorkspace
in interface IWorkspaceFactory
parentDirectory
- The parentDirectory (in)fileNames
- A reference to a com.esri.arcgis.system.IFileNames (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IWorkspaceName getWorkspaceName(String parentDirectory, IFileNames fileNames) throws IOException, AutomationException
GetWorkspaceName is useful when browsing the file system for workspaces. It is handed in a parent directory and the list of file names in the directory to be examined. It returns a WorkspaceName object representing the first workspace it finds in the list of filenames and removes any filenames representing the workspace from the input list of filenames.
getWorkspaceName
in interface IWorkspaceFactory
parentDirectory
- The parentDirectory (in)fileNames
- A reference to a com.esri.arcgis.system.IFileNames (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IUID getClassID() throws IOException, AutomationException
GetClassID returns the unique identifier for the workspace factory. You can use this to distinguish different versions of the same type of factory, for example, whether you are working with an SDEWorkspace, FileGDBWorkspace or AccessWorkspace factory.
getClassID
in interface IWorkspaceFactory
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean isWorkspace(String fileName) throws IOException, AutomationException
isWorkspace
in interface IWorkspaceFactory
fileName
- The fileName (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IPropertySet readConnectionPropertiesFromFile(String fileName) throws IOException, AutomationException
The filename parameter represents the pathname of a file that contains the connection information to be placed into the IPropertySet variable.
readConnectionPropertiesFromFile
in interface IWorkspaceFactory
fileName
- The fileName (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public String getWorkspaceDescription(boolean plural) throws IOException, AutomationException
getWorkspaceDescription
in interface IWorkspaceFactory
plural
- The plural (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public int getWorkspaceType() throws IOException, AutomationException
getWorkspaceType
in interface IWorkspaceFactory
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean copy(IWorkspaceName workspaceName, String destinationFolder, IWorkspaceName[] workspaceNameCopy) throws IOException, AutomationException
The Copy and Move methods can be used to copy or move workspaces or connection files between folders in the file system. The Boolean result indicates if the operation was successful. In the case of remote database workspaces, these operations work on the connection file representing the workspace.
copy
in interface IWorkspaceFactory
workspaceName
- A reference to a com.esri.arcgis.geodatabase.IWorkspaceName (in)destinationFolder
- The destinationFolder (in)workspaceNameCopy
- A reference to a com.esri.arcgis.geodatabase.IWorkspaceName (out: use single element array)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean move(IWorkspaceName workspaceName, String destinationFolder) throws IOException, AutomationException
The Copy and Move methods can be used to copy or move workspaces or connection files between folders in the file system. The Boolean result indicates if the operation was successful. In the case of remote database workspaces, these operations work on the connection file representing the workspace.
move
in interface IWorkspaceFactory
workspaceName
- A reference to a com.esri.arcgis.geodatabase.IWorkspaceName (in)destinationFolder
- The destinationFolder (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IWorkspace openFromString(String connectStr, int hWnd) throws IOException, AutomationException
The connect string is a collection of name value pairs separated by a semicolon (;).
openFromString
in interface IWorkspaceFactory2
connectStr
- The connectStr (in)hWnd
- The hWnd (A COM typedef) (in)
IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |