ArcGIS Runtime SDK for iOS: AGSGeodatabase.h Source File
ArcGIS Runtime SDK for iOS  100.15
AGSGeodatabase.h
Go to the documentation of this file.
1 /*
2  COPYRIGHT 2022 ESRI
3 
4  All rights reserved under the copyright laws of the United States
5  and applicable international laws, treaties, and conventions.
6 
7  This material is licensed for use under the Esri Master License
8  Agreement (MLA), and is bound by the terms of that agreement.
9  You may redistribute and use this code without modification,
10  provided you adhere to the terms of the MLA and include this
11  copyright notice.
12 
13  See use restrictions at http://www.esri.com/legal/pdfs/mla_e204_e300/english
14 
15  For additional information, contact:
16  Environmental Systems Research Institute, Inc.
17  Attn: Contracts and Legal Services Department
18  380 New York Street
19  Redlands, California, 92373
20  USA
21 
22  email: contracts@esri.com
23  */
24 
25 #import <Foundation/Foundation.h>
26 #import <ArcGIS/AGSLoadableBase.h>
27 #import <ArcGIS/AGSGeodatabaseTaskTypes.h>
28 #import <ArcGIS/AGSCancelable.h>
29 
31 @class AGSEnvelope;
32 @class AGSGeometry;
33 @class AGSUtilityNetwork;
34 @class AGSTableDescription;
35 @class AGSDomain;
37  //Required for Globals API doc
39 
49 
50 
51 #pragma mark -
52 #pragma mark initializers
53 
54 
55 
60 -(instancetype)initWithFileURL:(NSURL *)fileURL;
61 
67 -(instancetype)initWithName:(NSString *)name;
68 
74 +(instancetype)geodatabaseWithFileURL:(NSURL *)fileURL;
75 
82 +(instancetype)geodatabaseWithName:(NSString *)name;
83 
84 #pragma mark -
85 #pragma mark properties
86 
92 @property (nonatomic, copy, readonly) NSArray<AGSGeodatabaseFeatureTable *> *geodatabaseAnnotationTables;
93 
98 @property (nonatomic, copy, readonly) NSArray<AGSGeodatabaseFeatureTable*> *geodatabaseFeatureTables;
99 
103 @property (nonatomic, assign, readonly) BOOL inTransaction;
104 
108 @property (nonatomic, strong, readonly) NSURL *fileURL;
109 
124 @property (nullable, nonatomic, strong, readonly) AGSGeometry *generateGeodatabaseGeometry;
125 
129 @property (nullable, nonatomic, strong, readonly) NSURL *serviceURL;
130 
134 @property (nonatomic, assign, readonly) AGSSyncModel syncModel;
135 
139 @property (nonatomic, assign, readonly, getter=isSyncEnabled) BOOL syncEnabled;
140 
145 @property (nullable, nonatomic, strong, readonly) NSUUID *syncID;
146 
162 @property (nonatomic, assign, readonly) NSInteger minServerGeneration;
163 
169 @property (nonatomic, copy, readonly) NSArray<AGSUtilityNetwork *> *utilityNetworks;
170 
177 @property (nonatomic, copy, readonly) NSArray<AGSGeodatabaseFeatureTable *> *geodatabaseDimensionTables;
178 
184 @property (nonatomic, copy, readonly) NSArray<AGSDomain *> *domains;
185 
186 #pragma mark -
187 #pragma mark methods
188 
194 -(nullable AGSGeodatabaseFeatureTable *)geodatabaseAnnotationTableWithServiceLayerID:(NSInteger)serviceLayerID;
195 
201 -(nullable AGSGeodatabaseFeatureTable *)geodatabaseAnnotationTableWithTableName:(NSString *)tableName;
202 
209 -(nullable AGSGeodatabaseFeatureTable *)geodatabaseFeatureTableWithName:(NSString *)tableName;
210 
217 -(nullable AGSGeodatabaseFeatureTable *)geodatabaseFeatureTableByServiceLayerID:(NSInteger)serviceLayerID;
218 
227 -(BOOL)hasLocalEdits;
228 
233 -(void)close;
234 
239 -(BOOL)beginTransaction:(NSError **)error;
240 
244 -(BOOL)commitTransaction:(NSError **)error;
245 
249 -(BOOL)rollbackTransaction:(NSError **)error;
250 
257 - (nullable AGSUtilityNetwork *)utilityNetworkWithName:(NSString *)name;
258 
264 - (nullable AGSGeodatabaseFeatureTable *)geodatabaseDimensionTableWithServiceLayerID:(NSInteger)serviceLayerID;
265 
271 - (nullable AGSGeodatabaseFeatureTable *)geodatabaseDimensionTableWithTableName:(NSString *)tableName;
272 
282 + (id<AGSCancelable>)createWithFileURL:(NSURL *)fileURL
283  completion:(void(^)(AGSGeodatabase * __nullable result, NSError * __nullable error))completion;
284 
294 - (id<AGSCancelable>)createTableWithTableDescription:(AGSTableDescription *)tableDescription
295  completion:(void(^)(AGSGeodatabaseFeatureTable * __nullable result, NSError * __nullable error))completion;
296 
309 - (id<AGSCancelable>)deleteTableWithTableName:(NSString *)tableName
310  completion:(void(^)(NSError * __nullable error))completion;
311 
323 - (id<AGSCancelable>)createDomainWithDomainDescription:(AGSDomainDescription *)domainDescription
324  completion:(void(^)(AGSDomain * __nullable result, NSError * __nullable error))completion;
325 
336 - (id<AGSCancelable>)deleteDomainWithDomainName:(NSString *)domainName
337  completion:(void(^)(NSError * __nullable error))completion;
338 
339 
340 @end
341 
343 
348 @property (nullable, nonatomic, strong, readonly) AGSEnvelope *generateGeodatabaseExtent ;
349 
350 @end
AGSSyncModel
Definition: AGSGeodatabaseTaskTypes.h:57
Definition: AGSGeodatabase.h:342
An object that describes a domain to be created.
Definition: AGSDomainDescription.h:38
information about a field's domain
Definition: AGSDomain.h:37
A geometry that represents a rectangular shape.
Definition: AGSEnvelope.h:55
A Geodatabase dataset containing geographic features or non-spatial records.
Definition: AGSGeodatabaseFeatureTable.h:45
A geodatabase on disk.
Definition: AGSGeodatabase.h:49
NSURL * fileURL
Definition: AGSGeodatabase.h:108
BOOL syncEnabled
Definition: AGSGeodatabase.h:139
NSArray< AGSGeodatabaseFeatureTable * > * geodatabaseDimensionTables
Definition: AGSGeodatabase.h:177
NSArray< AGSDomain * > * domains
Definition: AGSGeodatabase.h:184
NSArray< AGSGeodatabaseFeatureTable * > * geodatabaseAnnotationTables
Definition: AGSGeodatabase.h:92
NSArray< AGSGeodatabaseFeatureTable * > * geodatabaseFeatureTables
Definition: AGSGeodatabase.h:98
NSURL * serviceURL
Definition: AGSGeodatabase.h:129
NSUUID * syncID
Definition: AGSGeodatabase.h:145
AGSGeometry * generateGeodatabaseGeometry
Definition: AGSGeodatabase.h:124
AGSSyncModel syncModel
Definition: AGSGeodatabase.h:134
NSArray< AGSUtilityNetwork * > * utilityNetworks
Definition: AGSGeodatabase.h:169
NSInteger minServerGeneration
Definition: AGSGeodatabase.h:162
BOOL inTransaction
Definition: AGSGeodatabase.h:103
Base class for all classes that represent geometric shapes.
Definition: AGSGeometry.h:121
A base class for loadables.
Definition: AGSLoadableBase.h:45
An object that describes an AGSGeodatabaseFeatureTable to be created.
Definition: AGSTableDescription.h:43
A utility network.
Definition: AGSUtilityNetwork.h:57
A protocol exposed by operations that allow cancellation.
Definition: AGSCancelable.h:38