How to build subsections in an NSFetchedResultsController - ios

I'm building an expense tracker where an Expense can belong to only one Category but can have multiple Tags. This is my object graph:
In the screen where I list all the expenses in a table view, I want the expenses to be grouped by date (the sectionDate), and then by Category (or, using a segmented control, by Tag). This is the intended UI:
I can already make an NSFetchedResultsController query all expenses, section them by date, then by category, but I can't get the (1) total for the category and (2) the list of expenses in it. How might I proceed to do that? This is my current code:
let fetchedResultsController: NSFetchedResultsController<NSFetchRequestResult> = {
let fetchRequest = NSFetchRequest<NSFetchRequestResult>(entityName: "Expense")
fetchRequest.resultType = .dictionaryResultType
fetchRequest.sortDescriptors = [
NSSortDescriptor(key: #keyPath(Expense.sectionDate), ascending: false)
]
fetchRequest.propertiesToFetch = [
#keyPath(Expense.sectionDate),
#keyPath(Expense.category)
]
fetchRequest.propertiesToGroupBy = [
#keyPath(Expense.sectionDate),
#keyPath(Expense.category)
]
let fetchedResultsController = NSFetchedResultsController(fetchRequest: fetchRequest,
managedObjectContext: Global.coreDataStack.viewContext,
sectionNameKeyPath: #keyPath(Expense.sectionDate),
cacheName: nil)
return fetchedResultsController
}()

A should forewarn that I've never done this, but personally I would set about it as follows:
Don't use propertiesToGroupBy: it forces you to use the .dictionaryResultType which means you can only access the underlying managed objects by executing a separate fetch.
Instead, add another computed property to the relevant NSManagedObject subclass, combining the sectionDate and the category.name. This property will be used as the sectionNameKeyPath for the FRC, so that the FRC will establish a section in the tableView for each unique combination of sectionDate and category name.
Add category.name as another sort descriptor for the fetch underlying the FRC. This will ensure that the Expense objects fetched by the FRC are in the correct order (ie. all Expense objects with the same sectionDate and category name are together).
Add a section header view for each section. The name property for the section (from the FRC) will include both the sectionDate and the category name. In most cases, you can strip out and ignore the sectionDate, displaying only the category name and corresponding total (see below). But for the very first section, and indeed the first section for any given sectionDate, add an additional view (to the section header view) showing the sectionDate and overall total for that sectionDate.
Working out whether a given section is the first section for the sectionDate is a little tricky. You could retrieve the name for the previous section and compare the sectionDates.
To collapse/expand the sections, maintain an array holding the collapsed/expanded state of each section. If the section is collapsed, return 0 in the tableView numberOfRowsInSection datasource method; if expanded use the figure provided by the FRC.
For the category totals, iterate through the objects array for the relevant section (or use a suitable .reduce to achieve the same).
For the sectionDate totals, filter the fetchedObjects for the FRC to include only the Expense objects for the relevant sectionDate, and then iterate or .reduce the filtered array.
I am happy to add or amend if any of that needs clarification.

I appreciate #pbasdf's answer, but I feel that I'll have a hard time wrapping my head around the solution after a long time of not looking at the code.
What I've come around to doing is instead of fetching Expense objects, I defined a new entity for the subsections themselves (CategoryGroup, and I will also make a TagGroup) and fetch those entities instead. These entities have references to the Expense objects that they contain, and the Category or the Tag that represents the group. This is my (partially complete) data model:
And my NSFetchedResultsController is now far simpler in code:
let fetchedResultsController: NSFetchedResultsController<CategoryGroup> = {
let fetchRequest = NSFetchRequest<CategoryGroup>(entityName: "CategoryGroup")
fetchRequest.sortDescriptors = [
NSSortDescriptor(key: #keyPath(CategoryGroup.sectionDate), ascending: false)
]
return NSFetchedResultsController(fetchRequest: fetchRequest,
managedObjectContext: Global.coreDataStack.viewContext,
sectionNameKeyPath: #keyPath(CategoryGroup.sectionDate),
cacheName: "CacheName")
}()
The downside is that I now have to write extra code to make absolutely sure that the relationships among the entities are correctly defined whenever an Expense or a Category is created/updated/deleted, but that's an acceptable tradeoff for me as it is easier to comprehend in code.

Related

How to group Core Data objects as the data source for a UITableView

In Core Data, I have a large number of "City" objects, each of which has a "country" property.
Rather than have a very long scrollable list of cities, I need to have a separate screen which lists just Countries in a UITableView. The user then selects a country and is taken to a new screen, which has the Cities for that Country.
Note: This is for a game, so the UITableView data source is bound to a SKScene, but I don't think that should make any difference as it works fine for other screens.
I have figured out the detail screen which displays the Cities for a specific country and it works fine in test with hard-coded data.
I am using Swift 5 so my data calls are like this:
let fetchRequest = NSFetchRequest<NSFetchRequestResult>(entityName: "City")
fetchRequest.sortDescriptors = [NSSortDescriptor(key: "name", ascending: true)]
fetchRequest.predicate = NSPredicate(format: "country = %#", country)
try fetchedResultsController.performFetch()
However for the other screen, I don't know how to "group" the Countries, which are the property on each City, and make the groupings the data source for the UITableView on the other screen.
a) I could create an array of Countries, but how would I have the fetchedResultsController return the Country data to UITableView?
b) Or, is it possible to group or filter objects within a fetchedResultsController?
c) Or, is it possible to do SQL-like grouping within a fetch request?
Thanks
Thanks #Larme for the link to https://developer.apple.com/documentation/coredata/nsfetchrequest/1506191-propertiestogroupby
So to get this working, Results Container needs to be defined with NSDictionary.
var fetchedResultsController: NSFetchedResultsController<NSDictionary>!
The fetchRequest needs to be set to group and fetch the specific property.
fetchRequest.propertiesToFetch = ["country"]
fetchRequest.propertiesToGroupBy = ["country"]
fetchRequest.resultType = .dictionaryResultType
Then in the methods where we need to access the data:
// cell data
let countryName = (fetchedResultsController.object(at: indexPath) as NSDictionary)["country"]!
cell.textLabel?.text = "\(countryName)"
Thanks for pointing me in the right direction!

Recursive fetch in CoreData

I have a data structure simplified to this:
So a folder can contain multiple folders or snippets and each snippet is part of a folder.
I want to fetch all Snippets which are in a given folder or which are in a folder which is a children of a specific folder.
The first case works for me, but I have problems getting the second case right.
To make this more clear here is an example:
When I select Folder C I'd like to get Snippet 3 but when I select Folder B or Folder A I'd like to get Snippet 1, Snippet 2 and Snippet 3.
This is what I currently have:
class Store {
...
func snippetsFetchRequest() -> NSFetchRequest<Snippet> {
let fetch: NSFetchRequest<Snippet> = Snippet.fetchRequest()
fetch.returnsObjectsAsFaults = false
fetch.relationshipKeyPathsForPrefetching = ["folder", "tags"]
fetch.sortDescriptors = [NSSortDescriptor(key: "updateDate", ascending: false)]
return fetch
}
...
}
let context = PersistenceManager.shared.mainContext
let store = SnippetStore(context: context)
fetchedResultsController = NSFetchedResultsController(fetchRequest: store.snippetsFetchRequest(),
managedObjectContext: context,
sectionNameKeyPath: nil,
cacheName: nil)
fetchedResultsController.fetchRequest.predicate = NSPredicate(format: "folder == %#", selectedFolder)
do {
try fetchedResultsController.performFetch()
} catch {
...
}
But this does only fetch the snippets which are direct children of the given/selected folder.
Is there any way I can solve my problem by still using NSFetchedResultsController?
You data structor is wrong. People tend to think about data structor as have a "correct" form for the given information; that you want to "model" the reality as close as possible. This is false. Your model only has value to the extent that it give you value for your particular application.
In this case, if you want to fetch all decedents of a folder it would be best to make a relationship to represent that. You can make a many-to-many relationship of decedents and ancestors that you can set whenever you add an object. If you need more properties for filtering or ordering you should add them, even if those properties can in theory be derived from the current tree model. Just make sure to keep them all in sync.

how to fetch last n records in CoreData using fetchedResultsController

I have a table Student which has two attributes Name and DateOfBirth.
I want to display names of students in a UITableView in descending order of their DateOfBirth that is younger one on top and older on bottom of the list.
I have created a FetchRequest that fetches all the students and displays in descending order of their DateOfBirth.
let studentFetchRequest = Student.fetchRequest()
let dateSortDescriptor = NSSortDescriptor(key: #keyPath(Student.dateOfBirth), ascending: false)
studentFetchRequest.sortDescriptors = [dateSortDescriptor]
let frc = NSFetchedResultsController<Student>(fetchRequest: studentFetchRequest, managedObjectContext: managedContext, sectionNameKeyPath: nil, cacheName: nil)
frc.performFetch()
Now, I have a requirement that I need to display only last 15 students. Considering Student table has 50 records.
I tried changing the sortDescriptor's ascending property to true and added fetchLimit of 15 to my studentFetchRequest to fetch only last 15 students.
It fetches the last 15 students but it reverses the order in which they are being listed in UITableView. i.e. older students on top and younger on the bottom.
How can I modify the fetchRequest and still be able to use a FetchedResultsController to display the last 15 students in my UITableView?
I need to use FetchedResultsController because the actual table is far complex, I have simplified the question to explain the situation.

NSFetchedResultsController with non unique section name

I am initialising NSFetchedResultsController with following code
self.fetchedResultsController = NSFetchedResultsController(
fetchRequest: request,
managedObjectContext: context,
sectionNameKeyPath: "article.name",cacheName: nil
)
Here articles can have same name.So article.name sectionNameKeyPath is non unique.In this case fetchedResultsController will have only single section.
How can I handle multiple section with same section name?
For the sectionKeyPath return a UUID for the section (article.articleId or the like). Then when you display the title for the header in section don't display the named returned from the fetchedResultsController (self.fetchedResultsController.sections[section].name), rather get the first object in the section and figure out what you really want to display based on that (self.fetchedResultsController.sections[section].objects.firstObject.article.name).

Adding new object to CoreData with one to many relation

I have CoreData model like this:
Parcel can have only one company, but company can have multiple parcels to deliver.
I have three companies in database preloaded. I have created table view with sections and loading data via NSFetchedResultsController.
I'm configuring it like this:
let fetchRequest = NSFetchRequest(entityName: EnityNames.PackageInfoEnityName)
// Add Sort Descriptors
let sortDescriptor = NSSortDescriptor(key: PackageInfoKeyPaths.Company, ascending: true)
fetchRequest.sortDescriptors = [sortDescriptor]
// Initialize Fetched Results Controller
let fetchedResultsController = NSFetchedResultsController(fetchRequest: fetchRequest, managedObjectContext: self.managedObjectContext, sectionNameKeyPath: PackageInfoKeyPaths.Company, cacheName: nil)
// Configure Fetched Results Controller
fetchedResultsController.delegate = self
return fetchedResultsController
When I'm launching app on simulator I have three sections(as expected), i want to have sections as companies displayed, so I'm using relationship as section name key path:
number of sections 3
FedEx
UPS
DHL
I have created popover where I can add new entries to database to populate list with additional data. This is the code I'm using to create and save new data:
let appDelegate = UIApplication.sharedApplication().delegate as! AppDelegate
let package =
NSEntityDescription.insertNewObjectForEntityForName(EnityNames.PackageInfoEnityName, inManagedObjectContext: managedObjectContext) as! PackageInfo
let formatter = NSNumberFormatter()
formatter.numberStyle = .DecimalStyle
package.parcelNumber = formatter.numberFromString(parcelNumberTextField.text!) ?? 0;
package.createdAt = NSDate()
let company = avaialbleCompanies![companyPickerView.selectedRowInComponent(0)]
package.company_relation = company
company.addPackageToCompany(package)
appDelegate.saveContext()
the companies array is passed in prepare for segue to my little popover to let user choose only companies that are inside database. After this I'm getting something strange:
number of sections 4
FedEx
UPS
UPS
Why it is adding new Section? It should just add new item to existing section!
and terrifying error:
PackageChecker[5336:281349] CoreData: error: Serious application error. An exception was caught from the delegate of NSFetchedResultsController during a call to -controllerDidChangeContent:. Invalid update: invalid number of sections. The number of sections contained in the table view after the update (4) must be equal to the number of sections contained in the table view before the update (3), plus or minus the number of sections inserted or deleted (0 inserted, 0 deleted). with userInfo (null)
Important part can be that I'm getting this:
updated index path 1x0
and I'm using fetchedResultsController.sections?.count to get number of sections.
If I restart the app on sim my newly added record is present in proper section inside list. Why it is not updating properly on runtime?
P.S. I have:
func controllerWillChangeContent(controller: NSFetchedResultsController) {
self.tableView.beginUpdates()
}
func controllerDidChangeContent(controller: NSFetchedResultsController) {
self.tableView.endUpdates()
}
Edit:
If I remove sectionNameKeyPath: PackageInfoKeyPaths.Company - adding works perfectly. Can You help me with this sections? Maybe I'm configuring them poorly.
The crash is occurring because the FRC is creating a new section, but your code does not currently create a corresponding tableView section. If you implement the NSFetchedResultsControllerDelegate method:
controller:didChangeSection:atIndex:forChangeType:
that should fix the crash.
But I'm afraid I can't see why the FRC is creating a new section.

Resources