{"id":16828810,"url":"https://github.com/pjfanning/poi-shared-strings","last_synced_at":"2025-03-22T04:30:30.332Z","repository":{"id":34599134,"uuid":"139277403","full_name":"pjfanning/poi-shared-strings","owner":"pjfanning","description":"Memory efficient Shared Strings Table implementation for POI streaming","archived":false,"fork":false,"pushed_at":"2024-04-19T13:31:09.000Z","size":11492,"stargazers_count":8,"open_issues_count":1,"forks_count":7,"subscribers_count":4,"default_branch":"main","last_synced_at":"2024-05-01T16:13:14.488Z","etag":null,"topics":["apache-poi","excel","java","poi"],"latest_commit_sha":null,"homepage":null,"language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/pjfanning.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":"pjfanning"}},"created_at":"2018-06-30T20:20:22.000Z","updated_at":"2024-06-17T22:42:31.334Z","dependencies_parsed_at":"2023-09-26T18:03:56.858Z","dependency_job_id":"51932d78-7496-4d5c-ac41-be573641e6a1","html_url":"https://github.com/pjfanning/poi-shared-strings","commit_stats":null,"previous_names":[],"tags_count":34,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pjfanning%2Fpoi-shared-strings","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pjfanning%2Fpoi-shared-strings/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pjfanning%2Fpoi-shared-strings/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pjfanning%2Fpoi-shared-strings/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/pjfanning","download_url":"https://codeload.github.com/pjfanning/poi-shared-strings/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244907420,"owners_count":20529850,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["apache-poi","excel","java","poi"],"created_at":"2024-10-13T11:28:36.039Z","updated_at":"2025-03-22T04:30:29.711Z","avatar_url":"https://github.com/pjfanning.png","language":"Java","funding_links":["https://github.com/sponsors/pjfanning"],"categories":[],"sub_categories":[],"readme":"![Build Status](https://github.com/pjfanning/poi-shared-strings/actions/workflows/ci.yml/badge.svg)\n[![Maven Central](https://maven-badges.herokuapp.com/maven-central/com.github.pjfanning/poi-shared-strings/badge.svg)](https://maven-badges.herokuapp.com/maven-central/com.github.pjfanning/poi-shared-strings)\n\n# poi-shared-strings\nMemory efficient Shared Strings Table implementation for [POI](https://poi.apache.org/) xlsx streaming.\n\nSupports read and write use cases when used with POI 5.x. poi-shared-strings 1.x supports POI 4.x.\n\nhttps://bz.apache.org/bugzilla/show_bug.cgi?id=61832\n\nThe `TempFileSharedStringsTable` uses a [H2 MVStore](http://www.h2database.com/html/mvstore.html) to store the Excel Shared String data. The MVStore data can be encrypted using a generated password.\n\nThis class can be used instead of the POI [SharedStringsTable](https://poi.apache.org/apidocs/org/apache/poi/xssf/model/SharedStringsTable.html) and [ReadOnlySharedStringsTable](https://poi.apache.org/apidocs/org/apache/poi/xssf/eventusermodel/ReadOnlySharedStringsTable.html).\nIt is only useful if you expect to need to support large numbers of shared string entries.\n\n## Usage\n\nWhen reading files, use `new TempFileSharedStringsTable(opcPackage, true)` to have the shared strings loaded from the xlsx package.\n\nIf you are using the TempFileSharedStringsTable when writing files (eg using [SXSSFWorkbook](https://poi.apache.org/apidocs/org/apache/poi/xssf/streaming/SXSSFWorkbook.html)), then use `new TempFileSharedStringsTable(true)` to create an empty table that you can add shared string entries to.\n\n## Comments Table\n\nv2.0.2 added support for `TempFileCommentsTable` which works in a similar way to `TempFileSharedStringsTable`.\n\nUp until v2.4.0, TempFileCommentsTable only supported read use cases. With v2.4.0, it can now be used with SXSSFWorkbook\nlike TempFileSharedStringsTable can.\n\nThis class can be used instead of the POI [CommentsTable](https://poi.apache.org/apidocs/dev/org/apache/poi/xssf/model/CommentsTable.html).\nIt is only useful if you expect to need to support large numbers of comments entries.\n\n\n## Full Format\n\nv2.1.0 added support for parsing the shared strings and comments and keeping the formatting the data. This is optional and not enabled by default.\nThis support requires a little extra memory. The default is to just extract the text of the shared strings and comments.\nFull Format support may not work when the files are in Strict OOXML format ([POI Issue](https://bz.apache.org/bugzilla/show_bug.cgi?id=57699)).\n\nThe current implementation of Full Format can be a lot slower than the plain text solution due to the extra XML parsing overhead.\n\n## Map-Backed implementations\n\nSince v2.5.0, you can now avoid using temp files by using Map-backed implementations.\n* MapBackedSharedStringsTable\n* MapBackedCommentsTable\n\n## Samples\n\nThere is an xlsx reading sample and also an xlsx writing sample at https://github.com/pjfanning/poi-shared-strings-sample.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpjfanning%2Fpoi-shared-strings","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpjfanning%2Fpoi-shared-strings","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpjfanning%2Fpoi-shared-strings/lists"}