Changes

{{Project|Has project output=Data,Tool,Content,How-to,Guide|Has sponsor=McNair ProjectsCenter

A <onlyinclude>The [[Reproducible Patent Data]] project is a continuation of the [[Redesigning Patent Database]] that project. It aims to write faster, more centralized code to deal with data from the United States Patent and Trademark Office (USPTO). By having an end-to-end pipeline we can easily reproduce or update data without worrying about unintentional side effects or missing data. See also the [[Patent Data]] umbrella project. </onlyinclude> == Quickstart == To get up and running with the code, do the following: # Clone the git project (link at end of page) to your user directory# Launch IntelliJ with >= Java 8 and Maven configured (default version installed on the RDP is setup to do this)# Open project in IntelliJ# Create an empty database (see [[#Database]])# Run the table creation scripts in <code>src/db/schemas/</code> in your new database# Modify the constant <code>DATABASE_NAME</code> in <code>E:\McNair\Projects\SimplerPatentData\src\main\java\org\bakerinstitute\mcnair\postgres\DatabaseHelper.java</code># Run the Driver scripts in IntelliJ with the correct value for <code>DATA_DIRECTORY</code> (or run <code>RunInitialImport.java</code> which will do all of the data directories for that patent item type)# [Take a really, really long lunch...in total should take no more than five hours to load data on RDP]# Run scripts in <code>src/db/constraints</code> to check data assumptions# That's it! ===Troubleshooting=== If you're new to IntelliJ (and even if you're not) you might run into problems with importing the project.  '''Setting Up Project as a Maven project'''It should be clear if the project is not set up as a Maven project - when you right click on RunInitialImport.java, for example, you won't see an option with a green triangle next to it that says "Run 'RunInitialImport.java'", and the green triangle in the top toolbar will be grayed out. If the project is not set up as a Maven project, you will not be able to run any of the code. To set up the project as a Maven project, when you import the project, follow the instructions at the following [https://www.jetbrains.com/help/idea/maven.html#maven_import_project_start link]. * Note that when you click "Import Project", you should select the "Simpler Patent Data" folder, not the "src" folder within Simpler Patent Data, otherwise you won't get the pom.xml file that you need to let IntelliJ know that this is a Maven project.* On the second window (there will be several options with check boxes next to them) make sure "import Maven projects automatically" is selected* On the "Please select project SDK" window, make sure it says "1.8" in the "Name" slot. * On the next window, enter a name for the project and enter a folder location. This should ensure that the project is set up as a Maven project.  '''Setting Up Your Data Source''' If you run into a message across the top that says something along the lines of "Configure Data Source", then you have not connected IntelliJ to a database. You will not be able to run the code located under src/db until you configure one. Start by clicking on the link in the message, or if it doesn't appear, follow the instructions [https://www.jetbrains.com/help/idea/connecting-to-a-database.html here] to open up the "Data Sources and Drivers" pop-up to add a PostgreSQL database. When you get to the dialogue asking about the host, database, user, and password, do the following to connect to the database on the RDP:  host: localhost database: whatever the constant DATABASE_NAME is set to - the default is patentsj user: postgres password: tabspaceenter Make sure to test the connection by clicking "Test Connection". Now you should be able to run the scripts under src/db. If you're seeing issues such as "column [something] of relation [something] doesn't exist" but you've run the schema scripts, you probably have different database name under the data source than the one the constant DATABASE_NAME is set to. To change this, right click on the data source in the Database tab and select "Properties".

The git repository can be found at httpshttp://rdp.mcnaircenter.org/codebase/Repository/ReproduciblePatent

<code>"C:\Program Files\Java\jdk1.8.0_131\bin\java" "-javaagent:C:\Users\OliverC\IntelliJ IDEA 2017.1.3\lib\idea_rt.jar=62364:C:\Users\OliverC\IntelliJ IDEA 2017.1.3\bin" -Dfile.encoding=UTF-8 -classpath "C:\Program Files\Java\jdk1[.8.0_131\jre\lib\charsets.jar;C:\Program Files\Java\jdk1contents truncated.8.0_131\jre\lib\deploy.jar;C:\Program Files\Java\jdk1.8.0_131\jre\lib\ext\access-bridge-64.jar;C:\Program Files\Java\jdk1.8.0_131\jre\lib\ext\cldrdata.jar;C:\Program Files\Java\jdk1.8.0_131\jre\lib\ext\dnsns.jar;C:\Program Files\Java\jdk1.8.0_131\jre\lib\ext\jaccess.jar;C:\Program Files\Java\jdk1.8.0_131\jre\lib\ext\jfxrt.jar;C:\Program Files\Java\jdk1.8.0_131\jre\lib\ext\localedata.jar;C:\Program Files\Java\jdk1.8.0_131\jre\lib\ext\nashorn.jar;C:\Program Files\Java\jdk1.8.0_131\jre\lib\ext\sunec.jar;C:\Program Files\Java\jdk1.8.0_131\jre\lib\ext\sunjce_provider.jar;C:\Program Files\Java\jdk1.8.0_131\jre\lib\ext\sunmscapi.jar;C:\Program Files\Java\jdk1.8.0_131\jre\lib\ext\sunpkcs11.jar;C:\Program Files\Java\jdk1.8.0_131\jre\lib\ext\zipfs.jar;C:\Program Files\Java\jdk1.8.0_131\jre\lib\javaws.jar;C:\Program Files\Java\jdk1.8.0_131\jre\lib\jce.jar;C:\Program Files\Java\jdk1.8.0_131\jre\lib\jfr.jar;C:\Program Files\Java\jdk1.8.0_131\jre\lib\jfxswt.jar;C:\Program Files\Java\jdk1.8.0_131\jre\lib\jsse.jar;C:\Program Files\Java\jdk1.8.0_131\jre\lib\management-agent.jar;C:\Program Files\Java\jdk1.8.0_131\jre\lib\plugin.jar;C:\Program Files\Java\jdk1.8.0_131\jre\lib\resources.jar;C:\Program Files\Java\jdk1.8.0_131\jre\lib\rt.jar;E:\McNair\Projects\SimplerPatentData\target\classes;C:\Users\OliverC\.m2\repository\com\mashape\unirest\unirest-java\1.4.9\unirest-java-1.4.9.jar;C:\Users\OliverC\.m2\repository\org\apache\httpcomponents\httpclient\4.5.2\httpclient-4.5.2.jar;C:\Users\OliverC\.m2\repository\org\apache\httpcomponents\httpcore\4.4.4\httpcore-4.4.4.jar;C:\Users\OliverC\.m2\repository\commons-logging\commons-logging\1.2\commons-logging-1.2.jar;C:\Users\OliverC\.m2\repository\org\apache\httpcomponents\httpasyncclient\4.1.1\httpasyncclient-4.1.1.jar;C:\Users\OliverC\.m2\repository\org\apache\httpcomponents\httpcore-nio\4.4.4\httpcore-nio-4.4.4.jar;C:\Users\OliverC\.m2\repository\org\apache\httpcomponents\httpmime\4.5.2\httpmime-4.5.2.jar;C:\Users\OliverC\.m2\repository\org\json\json\20160212\json-20160212.jar;C:\Users\OliverC\.m2\repository\com\google\guava\guava\21.0\guava-21.0.jar;C:\Users\OliverC\.m2\repository\org\jsoup\jsoup\1.10.2\jsoup-1.10.2.jar;C:\Users\OliverC\.m2\repository\commons-codec\commons-codec\1.10\commons-codec-1.10.jar;C:\Users\OliverC\.m2\repository\org\jetbrains\annotations\15.0\annotations-15.0.jar;C:\Users\OliverC\.m2\repository\org\apache\commons\commons-lang3\3.5\commons-lang3-3.5.jar];C:\Users\OliverC\.m2\repository\org\postgresql\postgresql\42.1.1\postgresql-42.1.1.jar" org.bakerinstitute.mcnair.uspto_assignments.XmlDriver</code>

TODO === Patents (also, there's a german pun somewhere in that headerGranted)===

! scope="col" | Dates Used !! scope="col" | Format !! scope="col" | Location !! scope="col" | Supported by Parser? !! scope="col" | Utility !! scope="col" | Reissue !! scope="col" | Design !! scope="col" | Plant

|✗~

|✗~

|✗~

|✗~

|✗~

|✗~

|✗~

|✗~

* PATN.WKU is the granted patent number. It is 7 digits while the spec promises 6 digits. The rightmost digit is a check digit modulus 11. See [[File:Aps-wku-modulus11.pdf]] for the words from the horse's mouth.

|January March 15, 2001 to December 2001

|style="background: red; color: whiteyellow;" | NoYes, for basic information, inventors, and correspondents

|style="background: red; color: whiteyellow;" | NoDitto

|style="background: yellow;" | MaybeDitto

|style="background: yellow;" | MaybeDitto

|style="background: yellow;" | MaybeDitto

|January 2013 to September 24, 2013December 2014

|style="background: yellow;" | MaybeDitto

|October 8, 2013 January 2015 to December 2014''Present''

|style="background: yellow;" | Maybe|-|January 2015 to December 2016|XML Version 4.5 ICE|<code>data/extracts/applications/modern</code>|style="background: yellow;" | MaybeDitto

# === Create an empty database: <code>$ createdb --usernameon RDP ===postgres patents_june_2017 # password is tabspaceenter</code># Create tables via script at <code>E:\McNair\Projects\SimplerPatentData\src\db\NaiveSchema.sql</code>#* Prior Example <code>E:\McNair\Software\Scripts\Patent\createTables.sql</code>#* Aim to create a completely naive schema with as few constraints as possible--iteratively add more constraints in the future

To create an empty database, run this command: <code>$ createdb --username=postgres database-name-goes-here # password is tabspaceenter</code> === Abstraction Layer === Since writing raw SQL is a bit cumbersome and error-prone, I have added some abstraction layers that make it much easier to quickly add bulk data. By using Postgres's <code>CopyManager</code> class, we buffer SQL copy commands in memory (as many as possible) and then flush these rows. To understand how the abstraction layers work, see the code in <code>E:\McNair\Projects\SimplerPatentData\src\main\java\org\bakerinstitute\mcnair\postgres</code>. For a concrete example, see See <code>E:\McNair\Projects\SimplerPatentData\src\main\java\org\bakerinstitute\mcnair\uspto_assignmentsmodels\GeonamesZipsGrantedPatent.java</code> for a '''simple, self-contained an exampleof how to extend''' or the abstraction layer to deal with more complex scenarios. === New Table Checklist === * Create schema DDL SQL code for the new table in <code>E:\McNair\Projects\SimplerPatentData\src\main\java\org\bakerinstitute\mcnair\models\GrantedPatent.javadb</code>* Run the schema creation* Create an enum with the same names for attributes as in the DDL (case-insensitive! prefer all-caps screaming snake case)* Create a class which subclasses <code>AbstractInsertableData</code>* Inside that class, create a static class which subclasses <code>AbstractTableMetadata</code> and has the proper values for '''an example of how getTableName(), getStringColumns(), getIntColumns()* (Optional) Implement builder pattern* (Optional) Create a custom databasehelper for complex extras (see PatentApplication and GrantedPatent for examples)* Write the data to extend''' the abstraction layer to deal with more complex scenarios.table (see DatabaseHelper for the pattern I use)

* Question: "In which zipcodes are To get the most patents granted?"** Hacky answer: <code>\COPY granular address data (select postcodestreet level, count(documentid) as c from june_2017_zipcode_join group by or at least postcode order by c desclevel) TO '/bulk/zipcodes-oliver/postcodes_rankedabout who owns patents, the path is not so straightforward because off the complicated mapping of ownership to a granted patent.This is the final part of this project that I am working on and it is all at the level of SQL.tsv' (format csv, delimiter E'\t')</code>** See <code>ZE:/zipcodes-oliver/postcodes_ranked.tsv\McNair\Projects\SimplerPatentData\src\db\joins</code>for my attempts to create a clean mapping.* Zipcode granularity--if possibleOptimistically speaking, finer detail wantedthe data generated here should be superset of the data present in the Patent Assignment Data Restructure project.* Filter non-USNote that as of the beginning of August 2017, null addressesthis part '''has not been completed.''' * Need to cleanup addresses* Extract zipcode or reverse locate to find zip=== Intuition ===

* "The 4-5 digit reel number refers Use <code>assignments_longform.last_update_date</code> to the microfilm reel number find current/latest (or first/earliest) date of the assignment entry in physical USPTO records; similarly the 1-4 digit frame number refers . Then match with <code>properties.docid</code> on <code>reelno, frameno</code> to find patent application id. With this mapping to granted patents, we can discover the location details of the assignment entry on the reel number in physical USPTO recordsoriginal granted patent. Thus, each assignment recorded And with the USPTO has a unique reel number right date and frame number combination. While both reel number reelno and frame number are sequentialframeno, there are missing values in we can match to the sequence because each only specifies the first page of the assignment records <code>assignees</code> table and records may have multiple pagesget fine granularity addresses." from https://www.uspto.gov/sites/default/files/documents/USPTO_Patents_Assignment_Dataset_WP.pdf, pg12, footnote 38

* [[Redesign_Assignment_and_Patent_Database|Redesign Assignment and Patent Database, Fall 2017 by Shelby]]* [[Equivalent_XPath_and_APS_Queries|Equivalent XPath and APS Queries, Summer 2017 by this guyOliver & Joe]]

* [[Patent_Litigation_and_Review|Patent Litigation and Review by Marcela]]* [[Bag_of_Words_Analysis_of_Patent_Data|Bag of Words Analysis]]* [[Patent|Existing Database Schema]]

* [httpshttp://rdp.mcnaircenter.org/codebase/Repository/ReproduciblePatent Git Repository]