NSIncrementalStore (moe.platform.ios API)

java.lang.Object
- org.moe.natj.general.NativeObject
- - org.moe.natj.objc.ObjCObject
  - - apple.NSObject
    - - apple.coredata.NSPersistentStore
      - apple.coredata.NSIncrementalStore

All Implemented Interfaces:

NSObject
```
public class NSIncrementalStore
extends NSPersistentStore
```
Abstract class defining the API through which Core Data communicates with a store. This API is designed to allow users to create persistent stores which load and save data incrementally, allowing for the management of large and/or shared datasets.

Nested Class Summary
- Nested classes/interfaces inherited from class apple.NSObject
  NSObject.Function_instanceMethodForSelector_ret, NSObject.Function_methodForSelector_ret

Constructor Summary

Constructors
Modifier Constructor and Description

protected NSIncrementalStore(org.moe.natj.general.Pointer peer)

Constructors
Modifier	Constructor and Description
`protected`	`NSIncrementalStore(org.moe.natj.general.Pointer peer)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static boolean`	`accessInstanceVariablesDirectly()`
`static NSIncrementalStore`	`alloc()`
`static NSIncrementalStore`	`allocWithZone(org.moe.natj.general.ptr.VoidPtr zone)`
`static boolean`	`automaticallyNotifiesObserversForKey(java.lang.String key)`
`static void`	`cancelPreviousPerformRequestsWithTarget(java.lang.Object aTarget)`
`static void`	`cancelPreviousPerformRequestsWithTargetSelectorObject(java.lang.Object aTarget, org.moe.natj.objc.SEL aSelector, java.lang.Object anArgument)`
`static NSArray<java.lang.String>`	`classFallbacksForKeyedArchiver()`
`static org.moe.natj.objc.Class`	`classForKeyedUnarchiver()`
`static java.lang.String`	`debugDescription_static()`
`static java.lang.String`	`description_static()`
`java.lang.Object`	`executeRequestWithContextError(NSPersistentStoreRequest request, NSManagedObjectContext context, org.moe.natj.general.ptr.Ptr<NSError> error)` Return a value as appropriate for the request, or nil if the request cannot be completed.
`static long`	`hash_static()`
`static java.lang.Object`	`identifierForNewStoreAtURL(NSURL storeURL)` API methods that may be overriden:
`NSIncrementalStore`	`init()`
`NSIncrementalStore`	`initWithPersistentStoreCoordinatorConfigurationNameURLOptions(NSPersistentStoreCoordinator root, java.lang.String name, NSURL url, NSDictionary<?,?> options)` the designated initializer for object stores.
`static NSObject.Function_instanceMethodForSelector_ret`	`instanceMethodForSelector(org.moe.natj.objc.SEL aSelector)`
`static NSMethodSignature`	`instanceMethodSignatureForSelector(org.moe.natj.objc.SEL aSelector)`
`static boolean`	`instancesRespondToSelector(org.moe.natj.objc.SEL aSelector)`
`static boolean`	`isSubclassOfClass(org.moe.natj.objc.Class aClass)`
`static NSSet<java.lang.String>`	`keyPathsForValuesAffectingValueForKey(java.lang.String key)`
`boolean`	`loadMetadata(org.moe.natj.general.ptr.Ptr<NSError> error)` CoreData expects loadMetadata: to validate that the URL used to create the store is usable (location exists, is writable (if applicable), schema is compatible, etc) and return an error if there is an issue.
`void`	`managedObjectContextDidRegisterObjectsWithIDs(NSArray<? extends NSManagedObjectID> objectIDs)` Inform the store that the objects with ids in objectIDs are in use in a client NSManagedObjectContext
`void`	`managedObjectContextDidUnregisterObjectsWithIDs(NSArray<? extends NSManagedObjectID> objectIDs)` Inform the store that the objects with ids in objectIDs are no longer in use in a client NSManagedObjectContext
`static NSDictionary<java.lang.String,?>`	`metadataForPersistentStoreWithURLError(NSURL url, org.moe.natj.general.ptr.Ptr<NSError> error)`
`static org.moe.natj.objc.Class`	`migrationManagerClass()`
`static NSIncrementalStore`	`new_objc()`
`NSManagedObjectID`	`newObjectIDForEntityReferenceObject(NSEntityDescription entity, java.lang.Object data)` Returns a new objectID with retain count 1 that uses data as the key.
`java.lang.Object`	`newValueForRelationshipForObjectWithIDWithContextError(NSRelationshipDescription relationship, NSManagedObjectID objectID, NSManagedObjectContext context, org.moe.natj.general.ptr.Ptr<NSError> error)` Returns the relationship for the given relationship on the object with ID objectID.
`NSIncrementalStoreNode`	`newValuesForObjectWithIDWithContextError(NSManagedObjectID objectID, NSManagedObjectContext context, org.moe.natj.general.ptr.Ptr<NSError> error)` Returns an NSIncrementalStoreNode encapsulating the persistent external values for the object for an objectID.
`NSArray<? extends NSManagedObjectID>`	`obtainPermanentIDsForObjectsError(NSArray<? extends NSManagedObject> array, org.moe.natj.general.ptr.Ptr<NSError> error)` Called before executeRequest with a save request, to assign permanent IDs to newly inserted objects; must return the objectIDs in the same order as the objects appear in array.
`java.lang.Object`	`referenceObjectForObjectID(NSManagedObjectID objectID)` Returns the reference data used to construct the objectID.
`static boolean`	`resolveClassMethod(org.moe.natj.objc.SEL sel)`
`static boolean`	`resolveInstanceMethod(org.moe.natj.objc.SEL sel)`
`static boolean`	`setMetadataForPersistentStoreWithURLError(NSDictionary<java.lang.String,?> metadata, NSURL url, org.moe.natj.general.ptr.Ptr<NSError> error)`
`static void`	`setVersion_static(long aVersion)`
`static org.moe.natj.objc.Class`	`superclass_static()`
`static long`	`version_static()`

Methods inherited from class apple.coredata.NSPersistentStore
configurationName, coreSpotlightExporter, didAddToPersistentStoreCoordinator, identifier, isReadOnly, metadata, options, persistentStoreCoordinator, setIdentifier, setMetadata, setReadOnly, setURL, type, URL, willRemoveFromPersistentStoreCoordinator

Methods inherited from class apple.NSObject
accessibilityActivate, accessibilityActivationPoint, accessibilityAssistiveTechnologyFocusedIdentifiers, accessibilityAttributedHint, accessibilityAttributedLabel, accessibilityAttributedUserInputLabels, accessibilityAttributedValue, accessibilityContainerType, accessibilityCustomActions, accessibilityCustomRotors, accessibilityDecrement, accessibilityDragSourceDescriptors, accessibilityDropPointDescriptors, accessibilityElementAtIndex, accessibilityElementCount, accessibilityElementDidBecomeFocused, accessibilityElementDidLoseFocus, accessibilityElementIsFocused, accessibilityElements, accessibilityElementsHidden, accessibilityFrame, accessibilityHint, accessibilityIncrement, accessibilityLabel, accessibilityLanguage, accessibilityNavigationStyle, accessibilityPath, accessibilityPerformEscape, accessibilityPerformMagicTap, accessibilityRespondsToUserInteraction, accessibilityScroll, accessibilityTextualContext, accessibilityTraits, accessibilityUserInputLabels, accessibilityValue, accessibilityViewIsModal, addObserverForKeyPathOptionsContext, attemptRecoveryFromErrorOptionIndex, attemptRecoveryFromErrorOptionIndexDelegateDidRecoverSelectorContextInfo, autoContentAccessingProxy, awakeAfterUsingCoder, awakeFromNib, class_objc, classForCoder, classForKeyedArchiver, copy, dealloc, debugDescription, description, dictionaryWithValuesForKeys, didChangeValueForKey, didChangeValueForKeyWithSetMutationUsingObjects, didChangeValuesAtIndexesForKey, doesNotRecognizeSelector, fileManagerShouldProceedAfterError, fileManagerWillProcessPath, finalize_objc, forwardingTargetForSelector, forwardInvocation, hash, indexOfAccessibilityElement, isAccessibilityElement, isEqual, isKindOfClass, isMemberOfClass, isProxy, methodForSelector, methodSignatureForSelector, mutableArrayValueForKey, mutableArrayValueForKeyPath, mutableCopy, mutableOrderedSetValueForKey, mutableOrderedSetValueForKeyPath, mutableSetValueForKey, mutableSetValueForKeyPath, observationInfo, observeValueForKeyPathOfObjectChangeContext, performSelector, performSelectorInBackgroundWithObject, performSelectorOnMainThreadWithObjectWaitUntilDone, performSelectorOnMainThreadWithObjectWaitUntilDoneModes, performSelectorOnThreadWithObjectWaitUntilDone, performSelectorOnThreadWithObjectWaitUntilDoneModes, performSelectorWithObject, performSelectorWithObjectAfterDelay, performSelectorWithObjectAfterDelayInModes, performSelectorWithObjectWithObject, prepareForInterfaceBuilder, provideImageDataBytesPerRowOrigin_Size_UserInfo, removeObserverForKeyPath, removeObserverForKeyPathContext, replacementObjectForCoder, replacementObjectForKeyedArchiver, respondsToSelector, self, setAccessibilityActivationPoint, setAccessibilityAttributedHint, setAccessibilityAttributedLabel, setAccessibilityAttributedUserInputLabels, setAccessibilityAttributedValue, setAccessibilityContainerType, setAccessibilityCustomActions, setAccessibilityCustomRotors, setAccessibilityDragSourceDescriptors, setAccessibilityDropPointDescriptors, setAccessibilityElements, setAccessibilityElementsHidden, setAccessibilityFrame, setAccessibilityHint, setAccessibilityLabel, setAccessibilityLanguage, setAccessibilityNavigationStyle, setAccessibilityPath, setAccessibilityRespondsToUserInteraction, setAccessibilityTextualContext, setAccessibilityTraits, setAccessibilityUserInputLabels, setAccessibilityValue, setAccessibilityViewIsModal, setIsAccessibilityElement, setNilValueForKey, setObservationInfo, setShouldGroupAccessibilityChildren, setValueForKey, setValueForKeyPath, setValueForUndefinedKey, setValuesForKeysWithDictionary, shouldGroupAccessibilityChildren, superclass, validateValueForKeyError, validateValueForKeyPathError, valueForKey, valueForKeyPath, valueForUndefinedKey, willChangeValueForKey, willChangeValueForKeyWithSetMutationUsingObjects, willChangeValuesAtIndexesForKey

Methods inherited from class org.moe.natj.objc.ObjCObject
equals, toString

Methods inherited from class org.moe.natj.general.NativeObject
finalize, getPeer, getPeerPointer

Methods inherited from class java.lang.Object
clone, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

NSIncrementalStore

protected NSIncrementalStore(org.moe.natj.general.Pointer peer)

Method Detail

accessInstanceVariablesDirectly

public static boolean accessInstanceVariablesDirectly()

alloc

public static NSIncrementalStore alloc()

allocWithZone

public static NSIncrementalStore allocWithZone(org.moe.natj.general.ptr.VoidPtr zone)

automaticallyNotifiesObserversForKey

public static boolean automaticallyNotifiesObserversForKey(java.lang.String key)

cancelPreviousPerformRequestsWithTarget

public static void cancelPreviousPerformRequestsWithTarget(java.lang.Object aTarget)

cancelPreviousPerformRequestsWithTargetSelectorObject

public static void cancelPreviousPerformRequestsWithTargetSelectorObject(java.lang.Object aTarget,
                                                                         org.moe.natj.objc.SEL aSelector,
                                                                         java.lang.Object anArgument)

classFallbacksForKeyedArchiver

public static NSArray<java.lang.String> classFallbacksForKeyedArchiver()

classForKeyedUnarchiver

public static org.moe.natj.objc.Class classForKeyedUnarchiver()

debugDescription_static

public static java.lang.String debugDescription_static()

description_static

public static java.lang.String description_static()

hash_static
```
public static long hash_static()
```

identifierForNewStoreAtURL

public static java.lang.Object identifierForNewStoreAtURL(NSURL storeURL)

API methods that may be overriden:

instanceMethodForSelector

public static NSObject.Function_instanceMethodForSelector_ret instanceMethodForSelector(org.moe.natj.objc.SEL aSelector)

instanceMethodSignatureForSelector

public static NSMethodSignature instanceMethodSignatureForSelector(org.moe.natj.objc.SEL aSelector)

instancesRespondToSelector

public static boolean instancesRespondToSelector(org.moe.natj.objc.SEL aSelector)

isSubclassOfClass

public static boolean isSubclassOfClass(org.moe.natj.objc.Class aClass)

keyPathsForValuesAffectingValueForKey

public static NSSet<java.lang.String> keyPathsForValuesAffectingValueForKey(java.lang.String key)

metadataForPersistentStoreWithURLError

public static NSDictionary<java.lang.String,?> metadataForPersistentStoreWithURLError(NSURL url,
                                                                                      org.moe.natj.general.ptr.Ptr<NSError> error)

migrationManagerClass

public static org.moe.natj.objc.Class migrationManagerClass()

new_objc

public static NSIncrementalStore new_objc()

resolveClassMethod

public static boolean resolveClassMethod(org.moe.natj.objc.SEL sel)

resolveInstanceMethod

public static boolean resolveInstanceMethod(org.moe.natj.objc.SEL sel)

setMetadataForPersistentStoreWithURLError

public static boolean setMetadataForPersistentStoreWithURLError(NSDictionary<java.lang.String,?> metadata,
                                                                NSURL url,
                                                                org.moe.natj.general.ptr.Ptr<NSError> error)

setVersion_static

public static void setVersion_static(long aVersion)

superclass_static

public static org.moe.natj.objc.Class superclass_static()

version_static
```
public static long version_static()
```

executeRequestWithContextError
```
public java.lang.Object executeRequestWithContextError(NSPersistentStoreRequest request,
                                                       NSManagedObjectContext context,
                                                       org.moe.natj.general.ptr.Ptr<NSError> error)
```
Return a value as appropriate for the request, or nil if the request cannot be completed. If the request is a fetch request whose result type is set to one of NSManagedObjectResultType, NSManagedObjectIDResultType, NSDictionaryResultType, return an array containing all objects in the store matching the request. If the request is a fetch request whose result type is set to NSCountResultType, return an array containing an NSNumber of all objects in the store matching the request. If the request is a save request, the result should be an empty array. Note that save requests may have nil inserted/updated/deleted/locked collections; this should be treated as a request to save the store metadata. Note that subclasses of NSIncrementalStore should implement this method conservatively, and expect that unknown request types may at some point be passed to the method. The correct behavior in these cases would be to return nil and an error.

init
```
public NSIncrementalStore init()
```
Overrides:

init in class NSPersistentStore

initWithPersistentStoreCoordinatorConfigurationNameURLOptions

public NSIncrementalStore initWithPersistentStoreCoordinatorConfigurationNameURLOptions(NSPersistentStoreCoordinator root,
                                                                                        java.lang.String name,
                                                                                        NSURL url,
                                                                                        NSDictionary<?,?> options)

Description copied from class: NSPersistentStore

the designated initializer for object stores.

Overrides:: initWithPersistentStoreCoordinatorConfigurationNameURLOptions in class NSPersistentStore

loadMetadata
```
public boolean loadMetadata(org.moe.natj.general.ptr.Ptr<NSError> error)
```
CoreData expects loadMetadata: to validate that the URL used to create the store is usable (location exists, is writable (if applicable), schema is compatible, etc) and return an error if there is an issue. Any subclass of NSIncrementalStore which is file-based must be able to handle being initialized with a URL pointing to a zero-length file. This serves as an indicator that a new store is to be constructed at the specified location and allows applications using the store to securly create reservation files in known locations.

Overrides:

loadMetadata in class NSPersistentStore

managedObjectContextDidRegisterObjectsWithIDs
```
public void managedObjectContextDidRegisterObjectsWithIDs(NSArray<? extends NSManagedObjectID> objectIDs)
```
Inform the store that the objects with ids in objectIDs are in use in a client NSManagedObjectContext

managedObjectContextDidUnregisterObjectsWithIDs
```
public void managedObjectContextDidUnregisterObjectsWithIDs(NSArray<? extends NSManagedObjectID> objectIDs)
```
Inform the store that the objects with ids in objectIDs are no longer in use in a client NSManagedObjectContext

newObjectIDForEntityReferenceObject

public NSManagedObjectID newObjectIDForEntityReferenceObject(NSEntityDescription entity,
                                                             java.lang.Object data)

Returns a new objectID with retain count 1 that uses data as the key.

newValueForRelationshipForObjectWithIDWithContextError

public java.lang.Object newValueForRelationshipForObjectWithIDWithContextError(NSRelationshipDescription relationship,
                                                                               NSManagedObjectID objectID,
                                                                               NSManagedObjectContext context,
                                                                               org.moe.natj.general.ptr.Ptr<NSError> error)

Returns the relationship for the given relationship on the object with ID objectID. If the relationship is a to-one it should return an NSManagedObjectID corresponding to the destination or NSNull if the relationship value is nil. If the relationship is a to-many, should return an NSSet or NSArray containing the NSManagedObjectIDs of the related objects. Should return nil and set the error if the source object cannot be found.

newValuesForObjectWithIDWithContextError

public NSIncrementalStoreNode newValuesForObjectWithIDWithContextError(NSManagedObjectID objectID,
                                                                       NSManagedObjectContext context,
                                                                       org.moe.natj.general.ptr.Ptr<NSError> error)

Returns an NSIncrementalStoreNode encapsulating the persistent external values for the object for an objectID. It should include all attributes values and may include to-one relationship values as NSManagedObjectIDs. Should return nil and set the error if the object cannot be found.

obtainPermanentIDsForObjectsError

public NSArray<? extends NSManagedObjectID> obtainPermanentIDsForObjectsError(NSArray<? extends NSManagedObject> array,
                                                                              org.moe.natj.general.ptr.Ptr<NSError> error)

Called before executeRequest with a save request, to assign permanent IDs to newly inserted objects; must return the objectIDs in the same order as the objects appear in array.

referenceObjectForObjectID
```
public java.lang.Object referenceObjectForObjectID(NSManagedObjectID objectID)
```
Returns the reference data used to construct the objectID. Will raise an NSInvalidArgumentException if the objectID was not created by this store.

Class NSIncrementalStore

Nested Class Summary

Nested classes/interfaces inherited from class apple.NSObject

Constructor Summary