Difference between revisions of "Equivalent XPath and APS Queries"

From edegan.com
Jump to navigation Jump to search
 
(167 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{McNair Projects
+
{{Project
 +
|Has project output=Tool
 +
|Has sponsor=McNair Center
 
|Has title=Equivalent XPath and APS Queries
 
|Has title=Equivalent XPath and APS Queries
 
|Has owner=Oliver Chang, Ed Egan,
 
|Has owner=Oliver Chang, Ed Egan,
 
|Has start date=June 2017
 
|Has start date=June 2017
 
|Has deadline=June 2017
 
|Has deadline=June 2017
|Has project status=Active
+
|Has project status=Tabled
 
|Depends upon it=Reproducible Patent Data
 
|Depends upon it=Reproducible Patent Data
 
}}
 
}}
  
  
[[Reproducible_Patent_Data#Schema_Reconciliation|Current Status]] for Granted Patents
+
[[Reproducible_Patent_Data#Schema_Reconciliation|Current Status]] for Granted Patents implementation
  
----
 
  
 
== How it works currently ==
 
== How it works currently ==
Line 18: Line 19:
 
That is to say, it only explicitly covers versions 4.3, 4.4, and 4.5 utility patents.
 
That is to say, it only explicitly covers versions 4.3, 4.4, and 4.5 utility patents.
 
Plant, reissue, and design patents contain a nonempty intersection with these attributes but have their own quirks.
 
Plant, reissue, and design patents contain a nonempty intersection with these attributes but have their own quirks.
The actual code to do this XML parsing is at <code>E:\McNair\Projects\SimplerPatentData\src\main\java\org\bakerinstitute\mcnair\uspto_granted\XmlParser.java</code>
+
The actual code to do this XML parsing is at <code>E:\McNair\Projects\SimplerPatentData\src\main\java\org\bakerinstitute\mcnair\uspto_granted\XmlParser.java</code> with the end goal to create an in-memory representation of a granted patent as a <code>E:\McNair\Projects\SimplerPatentData\src\main\java\org\bakerinstitute\mcnair\models\GrantedPatent.java</code> data structure.
 +
 
 +
To learn about the fields that a model contains, look at the class Model.Metadata which should implement interface <code>TableMetadata</code>. In particular, this bunch of constant data describes the mapping of enum fields to table column names as well as the types of columns.
 +
 
 +
For an example, we can tell that <code>GrantedPatent</code> is a struct that contains the following data:
 +
 
 +
<nowiki>
 +
private final Map<GrantedPatent.Fields, String> strings;
 +
private final Map<GrantedPatent.Fields, Double> numbers;
 +
private final List<Citation> citations;
 +
private final List<Sciref> scirefs;
 +
private final List<Inventor> inventors;
 +
private final List<AssignmentSummary> assignments;
 +
private final List<Lawyer> lawyers;</nowiki>
 +
 
 +
== Query Equivalences ==
 +
Note: xpaths are for all design types (utility, reissue, plant, design)  unless otherwise noted.  Only granted patents have been checked so far.
 +
 
 +
Notes to remember:
 +
 
 +
All the text under each text file in E:\McNair\Projects\SimplerPatentData\data\examples\granted appears under the following lines of text, indicating that every XML should perhaps include these headers (the headers aren't closed anywhere in the text files in E:\McNair\Projects\SimplerPatentData\data\examples\granted; for example, there's no </us-patent-grant> towards the end of the text file. 
 +
 
 +
<nowiki>
 +
<?xml version="1.0" encoding="UTF-8"?>
 +
<!DOCTYPE us-patent-grant SYSTEM "us-patent-grant-v45-2014-04-03.dtd" [ ]>
 +
<us-patent-grant</nowiki>
 +
 
 +
Ignoring the above three lines for every text file (changes to XMLs can be made later with RegEx), the XMLs for ''sequence'', and ''last-name'', respectively, from the lines of code below it are:
 +
 
 +
<nowiki>//us-bibliographic-data-grant/inventors/inventor/@sequence</nowiki>
 +
<nowiki>//us-bibliographic-data-grant/inventors/inventor/addressbook/last-name</nowiki>
 +
 
 +
<nowiki><inventors>
 +
<inventor sequence="001" designation="us-only">
 +
<addressbook>
 +
<last-name>Kobelt</last-name>
 +
<first-name>Markus</first-name>
 +
<address>
 +
<city>Buchs</city>
 +
<country>CH</country>
 +
</address>
 +
</addressbook>
 +
</inventor></nowiki>
 +
 
 +
 
 +
 
 +
Also note: the lack of a certain entry for a certain version and type simply means that it was missing from the single example located in the E:\McNair\Projects\SimplerPatentData\data\examples\Patent Schema Reconciliation\granted file.  The presence or lack of a certain entry could mean either that it is missing systematically (and would presumably be missing for all other examples of that version and type), or simply that that single example, in contrast to other examples for that version and type, lacked an entry. 
 +
 
 +
 
 +
==Granted==
 +
 
 +
=== strings ===
 +
 
 +
* '''PATENT_TYPE'''
 +
** XML 4.0, 4.1, 4.2, 4.3, 4.4, 4.5
 +
*** <code>//us-bibliographic-data-grant/application-reference/@appl-type</code>
 +
***example: utility
 +
** APS
 +
*** <code>PATN:APT</code>
 +
 
 +
* '''TITLE'''
 +
** XML 4.0, 4.1, 4.2, 4.3, 4.4, 4.5
 +
*** <code>//us-bibliographic-data-grant/invention-title</code>
 +
***example: Seeding implement depth adjustment mechanism
 +
** APS
 +
*** <code>PATN:TTL</code>
 +
 
 +
* '''PCT_DOCUMENT_NUMBER'''
 +
** only for XML 4.0 utility, 4.2 utility, 4.3 reissue
 +
*** <code>//us-bibliographic-data-grant/pct-or-regional-filing-data/document-id/doc-number</code>
 +
***example: PCT/IT03/00298
 +
** APS
 +
*** <code>PCTA:PCN</code>
 +
 
 +
* '''PATENT_COUNTRY'''
 +
** XML 4.0, 4.1, 4.2, 4.3, 4.4, 4.5
 +
*** <code>//us-bibliographic-data-grant/publication-reference/document-id/country</code>
 +
***example: US
 +
** APS
 +
*** ?
 +
 
 +
* '''PATENT_NUMBER'''
 +
** XML 4.0, 4.1, 4.2, 4.3, 4.4, 4.5
 +
*** <code>//us-bibliographic-data-grant/publication-reference/document-id/doc-number</code>
 +
***example: 09521796
 +
** APS
 +
*** <code>PATN:WKU</code>
 +
 
 +
* '''PATENT_KIND'''
 +
** XML 4.0, 4.1, 4.2, 4.3, 4.4, 4.5
 +
*** <code>//us-bibliographic-data-grant/publication-reference/document-id/kind</code>
 +
***example: B2
 +
** APS
 +
*** ?
 +
 
 +
* '''PATENT_GRANT_DATE'''
 +
** XML 4.0, 4.1, 4.2, 4.3, 4.4, 4.5
 +
*** <code>//us-bibliographic-data-grant/publication-reference/document-id/date</code>
 +
***example: 20161220
 +
** APS
 +
*** <code>PATN:ISD</code>
 +
 
 +
* '''APPLICATION_NUMBER'''
 +
** XML 4.0, 4.1, 4.2, 4.3, 4.4, 4.5
 +
*** <code>//us-bibliographic-data-grant/application-reference/document-id/doc-number</code>
 +
***example: 14182202
 +
** APS
 +
*** <code>PATN:APN</code>
 +
 
 +
* '''APPLICATION_FILING_DATE'''
 +
** XML 4.0, 4.1, 4.2, 4.3, 4.4, 4.5
 +
*** <code>//us-bibliographic-data-grant/application-reference/document-id/date</code>
 +
***example: 20140217
 +
** APS
 +
*** <code>PATN:APD</code>
 +
 
 +
* '''PRIORITY_CLAIMS_DATE'''
 +
** XML 4.0 only design, reissue, and utility types, 4.1 only utility type,  4.2 only utility type, 4.4 only reissue type
 +
*** <code>//us-bibliographic-data-grant/priority-claims/priority-claim/date</code>
 +
***example: 20000330
 +
** APS
 +
*** <code>PRIR:APD</code>
 +
 
 +
* '''PRIORITY_CLAIMS_COUNTRY'''
 +
** XML 4.0 only design, reissue, and utility types, 4.1 only utility type,  4.2 only utility type, 4.4 only reissue type
 +
*** <code>//us-bibliographic-data-grant/priority-claims/priority-claim/country</code>
 +
***example: GB
 +
** APS
 +
*** <code>PRIR:CNT</code>
 +
 
 +
* '''PRIORITY_CLAIMS_PATENT_NUMBER'''
 +
** XML 4.0 only design, reissue, and utility types, 4.1 only utility type,  4.2 only utility type, 4.4 only reissue type
 +
*** <code>//us-bibliographic-data-grant/priority-claims/priority-claim/doc-number</code>
 +
***example: 0007806.3
 +
** APS
 +
*** <code>PRIR:APN</code>
 +
 
 +
* '''IPCR_SUBCLASS'''
 +
** XML 4.1, 4.2, 4.3, 4.4 and 4.5, only for plant, reissue, and utility types
 +
*** <code>//us-bibliographic-data-grant/classifications-ipcr/classification-ipcr/subclass</code>
 +
***example: C
 +
** APS
 +
*** ?
 +
 
 +
* '''IPCR_MAIN_GROUP'''
 +
** XML 4.1, 4.2, 4.3, 4.4 and 4.5, only for plant, reissue, and utility types
 +
*** <code>//us-bibliographic-data-grant/classifications-ipcr/classification-ipcr/main-group</code>
 +
***example: 11
 +
** APS
 +
*** ?
 +
 
 +
* '''IPCR_SUB_GROUP'''
 +
** XML 4.1, 4.2, 4.3, 4.4 and 4.5, only for plant, reissue, and utility types
 +
*** <code>//us-bibliographic-data-grant/classifications-ipcr/classification-ipcr/subgroup</code>
 +
***example: 00
 +
** APS
 +
*** ?
 +
 
 +
* '''CPC_SUBCLASS'''
 +
** for XML 4.5 utility, reissue types
 +
*** <code>//us-bibliographic-data-grant/classifications-cpc/main-cpc/classification-cpc/subclass</code>
 +
example: C
 +
** APS
 +
*** ?
 +
 
 +
* '''CPC_MAIN_GROUP'''
 +
** XML 4.5 types utility, reissue types
 +
*** <code>//us-bibliographic-data-grant/classifications-cpc/main-cpc/classification-cpc/main-group</code>
 +
***example: 49
 +
** APS
 +
*** ?
 +
 
 +
* '''CPC_SUB_GROUP'''
 +
** XML 4.5 types utility, reissue types
 +
*** <code>//us-bibliographic-data-grant/classifications-cpc/main-cpc/classification-cpc/subgroup</code>
 +
***example: 027
 +
** APS
 +
*** ?
 +
 
 +
* '''CLASSIFICATION_NATIONAL_COUNTRY'''
 +
** XML 4.0,  (first listed is highest preference)
 +
*** <code>//us-bibliographic-data-grant/classification-national/country</code>
 +
***example: US
 +
** XML 4.1, 4.2, 4.3, 4.4, 4.5
 +
*** <code>//us-bibliographic-data-grant/us-field-of-classification-search/classification-national/country</code>
 +
***example: US
 +
** APS
 +
*** ?
 +
 
 +
* '''CLASSIFICATION_NATIONAL_CLASS'''
 +
** XML 4.0, 4.1, 4.2, 4.3, 4.4, 4.5 (first listed is highest preference)
 +
*** <code>//us-bibliographic-data-grant/classification-national/main-classification</code>
 +
***examples:
 +
****for v4.5 utility: 172610
 +
****for v4.5 reissue type:  16250
 +
****for v4.5 plant type: PLT161
 +
****for v4.5 design type:  2159, D30158, D 2614
 +
****for v4.4 utility type:  2 85,  2126
 +
****for v4.4 reissue type: 248415, 211 47, 2482821
 +
****for v4.4 plant type: PLT104
 +
****for v4.4 design type: 0101
 +
****for v4.3 utility type:  2159,  40615, 430  1
 +
****for v4.3 reissue type: 257341, 257328-377, 257E29076
 +
****for v4.3 plant type: PLT115
 +
****for v4.3 design type: 0101, D 1107, D 75513, D20 29, D 1100-199, D11108
 +
****for v4.2 utility type:  92140, 277444
 +
****for v4.2 reissue type: 134 21,  15345,  8158
 +
****for v4.2 plant type: PLT 308
 +
****for v4.2 design type: 0202, D 2719,  2113,  2 695,  2 69,
 +
****for v4.1 utility type: 453 33, 453  3, 453 10- 13
 +
****for v4.1 reissue type: 700241, 340  59, 377  7, 700230-238, 34082535
 +
****for v4.1 plant type: PLT373,
 +
****for v4.1 design type: 0101, D 1125, 426390, 4251311, 426 95, D 1100- 30, D11  6, D11 13, D11 17-  8, D11 20, 426103-  4, D21672, 264 75
 +
****for v40 utility type: F01L  134, 123 9016, 123 906,  74 53,  74567
 +
****for v40 reissue type: A61B  5024, 600519, 600515-517, 607  4, 607 14
 +
****for v40 plant type: A01H  500, PLT318
 +
****for v40 design type: 0206, D 2617,  2159, D291171, D29113, D29122-123, D 2613-621,  2 16,  21161-1168
 +
** APS
 +
*** ?
 +
 
 +
* '''PRIMARY_EXAMINER_FIRST_NAME'''
 +
** XML 4.0, 4.1, 4.2, 4.3, 4.4, 4.5
 +
*** <code>//us-bibliographic-data-grant/examiners/primary-examiner/first-name</code>
 +
***examples:
 +
****For v4.5, Christopher
 +
****For v4.2-v4.4, Deanna L, Karen
 +
****For v4.0-v4.1, Donald P., Kent
 +
** APS
 +
*** <code>PATN:EXP</code> (whole name)
 +
 
 +
* '''PRIMARY_EXAMINER_LAST_NAME'''
 +
** XML 4.0, 4.1, 4.2, 4.3, 4.4, 4.5
 +
*** <code>//us-bibliographic-data-grant/examiners/primary-examiner/last-name</code>
 +
***example: Novosad
 +
** APS
 +
*** N/A (<code>PATN:EXP</code> has whole name)
 +
 
 +
* '''PRIMARY_EXAMINER_DEPARTMENT'''
 +
** XML 4.0, 4.1, 4.2, 4.3, 4.4, 4.5
 +
*** <code>//us-bibliographic-data-grant/examiners/primary-examiner/department</code>
 +
***example: 3745
 +
** APS
 +
*** ?
 +
 
 +
=== numbers ===
 +
 
 +
* '''NUMBER_OF_CLAIMS'''
 +
** XML 4.0, 4.1, 4.2, 4.3, 4.4, 4.5
 +
*** <code>//us-bibliographic-data-grant/number-of-claims</code>
 +
***example : 10
 +
** APS
 +
*** <code>PATN:NCL</code>
 +
 
 +
=== applicants ===
 +
 
 +
* '''SEQUENCE'''
 +
** XML 4.3, 4.4, 4.5
 +
*** <code>//us-bibliographic-data-grant/us-parties/us-applicants/us-applicant/sequence</code>
 +
***example: "001"
 +
** XML 4.0, 4.1, 4.2
 +
*** <code>//us-bibliographic-data-grant/parties/applicants/applicant/sequence</code>
 +
***example: "001"
 +
** APS
 +
*** ?
 +
 
 +
* '''LAST_NAME'''
 +
** XML 4.3, 4.4, 4.5
 +
*** <code>//us-bibliographic-data-grant/us-parties/us-applicants/us-applicant/addressbook/last-name</code>
 +
***example: Maas
 +
** XML 4.0, 4.1, 4.2
 +
*** <code>//us-bibliographic-data-grant/parties/applicants/applicant/addressbook/last-name</code>
 +
***example: Ryder
 +
** APS
 +
*** N/A (see '''ORG_NAME''')
 +
 
 +
* '''FIRST_NAME'''
 +
** XML 4.3, 4.4, 4.5
 +
*** <code>//us-bibliographic-data-grant/us-parties/us-applicants/us-applicant/addressbook/first-name</code>
 +
***example: Nicholas George Alfred, Kevin
 +
** XML 4.0, 4.1, 4.2
 +
*** <code>//us-bibliographic-data-grant/parties/applicants/applicant/addressbook/first-name</code>
 +
***example: Gerhard
 +
** APS
 +
*** N/A (see '''ORG_NAME''')
 +
 
 +
* '''ORG_NAME'''
 +
** XML v4.5 utility, reissue, plant
 +
*** <code>//us-bibliographic-data-grant/us-parties/us-applicants/us-applicant/addressbook/orgname</code>
 +
***examples: W. Kordes' S&#xf6;hne Rosenschulen GmbH &#x26; Co KG [this is one example, included to show the variety of characters/symbols included in orgnames]
 +
*** <code>INVT:NAM</code> (whole name, might be of an individual)
 +
 
 +
* '''CITY'''
 +
** XML v4.3-v4.5, all types
 +
*** <code>//us-bibliographic-data-grant/us-parties/us-applicants/us-applicant/addressbook/address/city</code>
 +
*** example:New York; M&#xe9;xico D. F.
 +
**XML v4.0-v4.2
 +
***<code>//us-bibliographic-data-grant/parties/applicants/applicant/addressbook/address/city</code>
 +
** APS
 +
*** <code>INVT:CTY</code>
 +
 
 +
* '''COUNTRY'''
 +
** XML v4.3-v4.5, all types
 +
*** <code>//us-bibliographic-data-grant/us-parties/us-applicants/us-applicant/addressbook/address/country</code>
 +
*** example:New York; M&#xe9;xico D. F.
 +
**XML v4.0-v4.2, all types
 +
***<code>//us-bibliographic-data-grant/parties/applicants/applicant/addressbook/address/country</code>
 +
** APS
 +
*** <code>INVT:CNT</code>
 +
 
 +
* '''STATE'''
 +
** XML v4.3-v4.5, all types
 +
*** <code>//us-bibliographic-data-grant/us-parties/us-applicants/us-applicant/addressbook/address/state</code>
 +
*** example:New York; M&#xe9;xico D. F.
 +
**XML v4.0-v4.2, all types
 +
***<code>//us-bibliographic-data-grant/parties/applicants/applicant/addressbook/address/state</code>
 +
** APS
 +
*** <code>INVT:STA</code>
 +
 
 +
* '''ADDRESS'''
 +
** XML v4.3-v4.5, all types
 +
*** <code>//us-bibliographic-data-grant/us-parties/us-applicants/us-applicant/addressbook/address</code>
 +
*** example:New York; M&#xe9;xico D. F.
 +
** XML v4.0-v4.2, all types
 +
***<code>//us-bibliographic-data-grant/parties/applicants/applicant/addressbook/address</code>
 +
*** Examples:
 +
 
 +
<nowiki>
 +
<city>London</city>
 +
<country>GB</country></nowiki>
 +
 
 +
<nowiki>
 +
<city>Coraopolis</city>
 +
<state>PA</state>
 +
<country>US</country></nowiki>
 +
 
 +
* '''POSTCODE'''
 +
** XML v4.2 design
 +
*** Example: <code>//us-bibliographic-data-grant/parties/applicants/applicant/addressbook/address/postcode</code>
 +
** APS
 +
*** <code>INVT:ZIP</code>
 +
 
 +
=== scirefs (all are strings-unsure??) ===
 +
 
 +
===Citations===
 +
 
 +
* '''CITATION_DESCRIPTION'''
 +
** XML 4.3 design type, 4.4 reissue type, 4.5 all types
 +
*** <code>//us-bibliographic-data-grant/us-references-cited/us-citation/nplcit/othercit</code>
 +
***examples:
 +
****www.bikesomewhere.com/bikesomewhere.cfm/product/7/4138/15270
 +
****Photograph that is representative of an angle-cut tip for a continuous geared hinge that was publicly used or on sale more than one (1) year prior to the filing date of U.S. Appl. No. 61/231,249, filed Aug. 4, 2009.
 +
** XML 4.0 reissue type, 4.1 plant type, 4.2 all types
 +
*** <code>//us-bibliographic-data-grant/references-cited/citation/nplcit/othercit</code>
 +
***example: http://www.cpvo.eu.int/module_tech/rights_granted.php?SPECIED=FIT02.
 +
** APS
 +
*** ?
 +
 
 +
* '''CITATION NUMBER'''
 +
** XML v4.3-v4.5, design, reissue and utility types
 +
*** <code>//us-bibliographic-data-grant/us-references-cited/us-citation/patcit/num</code>
 +
***example: "00001"
 +
**XML v4.0-v4.2, design, reissue and utility types
 +
***example: "00001"
 +
*** <code>//us-bibliographic-data-grant/references-cited/citation/patcit/num</code>
 +
 
 +
 
 +
*'''NPL CITATION NUMBER'''
 +
**XML v4.5, v4.4 reissue, v4.3 design
 +
*** <code>//us-bibliographic-data-grant/us-references-cited/us-citation/nplcit/num</code>
 +
*** example:"00017"
 +
**XML v4.2 utility, reissue, design types, 4.1 plant type, v4.0 reissue type
 +
*** <code>//us-bibliographic-data-grant/references-cited/citation/nplcit/num</code>
 +
***example: "00007"
 +
 
 +
*'''COUNTRY'''
 +
** XML v4.3-v4,5 design, reissue, utility types
 +
*** <code>//us-bibliographic-data-grant/us-references-cited/us-citation/patcit/document-id/country>
 +
***example: US
 +
** XML v4.0-v4.2 design, reissue, utility types
 +
*** <code>//us-bibliographic-data-grant/references-cited/citation/patcit/document-id/country></code>
 +
***example: US
 +
 
 +
*'''CITATIONS DOC NUMBER'''
 +
** XML v4.3-v4.5 design, reissue, utility types
 +
*** <code>//us-bibliographic-data-grant/us-references-cited/us-citation/patcit/document-id/doc-number>
 +
***example: 19830700
 +
** XML v4.0-v4.2 design, reissue, utility types
 +
*** <code>//us-bibliographic-data-grant/references-cited/citation/patcit/document-id/doc-number></code>
 +
***example: 4393877
 +
 
 +
*'''CITATIONS KIND'''
 +
** XML v4.3-v4.5 design, reissue, utility types
 +
*** <code>//us-bibliographic-data-grant/us-references-cited/us-citation/patcit/document-id/kind>
 +
***example: B1
 +
** XML v4.0-v4.2 design, reissue, utility types
 +
*** <code>//us-bibliographic-data-grant/references-cited/citation/patcit/document-id/kind></code>
 +
***example: A
 +
 
 +
*'''CITATIONS NAME'''
 +
** XML v4.3-v4.5 design, reissue, utility types
 +
*** <code>//us-bibliographic-data-grant/us-references-cited/us-citation/patcit/document-id/name>
 +
***example: Prairie et al.
 +
** XML v4.0-v4.2 design, reissue, utility types
 +
*** <code>//us-bibliographic-data-grant/references-cited/citation/patcit/document-id/name>
 +
***example: Imran et al.
 +
 
 +
*'''CITATIONS DATE'''
 +
** XML v4.3-v4.5 design, reissue, utility types
 +
*** <code>//us-bibliographic-data-grant/us-references-cited/us-citation/patcit/document-id/date>
 +
***example: 20020500
 +
** XML v4.0-v4.2 design, reissue, utility types
 +
*** <code>//us-bibliographic-data-grant/references-cited/citation/patcit/document-id/date>
 +
***example: 19830700
 +
 
 +
=== inventors (all are strings) ===
 +
 
 +
* '''SEQUENCE'''
 +
** XML 4.3, 4.4, 4.5, all types
 +
*** <code>//us-bibliographic-data-grant/us-parties/inventors/inventor/sequence</code>
 +
***examples: "001"; "002"
 +
** APS
 +
*** ?
 +
 
 +
* '''LAST_NAME'''
 +
** XML 4.3, 4.4, 4.5, all types
 +
*** <code>//us-bibliographic-data-grant/us-parties/inventors/inventor/addressbook/last-name</code>
 +
***example: Maas
 +
** APS
 +
*** N/A (see '''ORG_NAME''')
 +
 
 +
* '''FIRST_NAME'''
 +
** XML 4.3, 4.4, 4.5, all types
 +
*** <code>//us-bibliographic-data-grant/us-parties/inventors/inventor/addressbook/first-name</code>
 +
***example: Nicholas George Alfred, Kevin
 +
** APS
 +
*** N/A (see '''ORG_NAME''')
 +
 
 +
 
 +
* '''CITY'''
 +
** XML v4.3-v4.5, all types
 +
*** <code>//us-bibliographic-data-grant/us-parties/inventors/inventor/addressbook/address/city</code>
 +
*** example: Beaverton
 +
** APS
 +
*** <code>INVT:CTY</code>
 +
 
 +
* '''COUNTRY'''
 +
** XML v4.3-v4.5, all types
 +
*** <code>//us-bibliographic-data-grant/us-parties/inventors/inventor/addressbook/address/country</code>
 +
*** example: US
 +
** APS
 +
*** <code>INVT:CNT</code>
 +
 
 +
* '''STATE'''
 +
** XML v4.3-v4.5, all types
 +
*** <code>//us-bibliographic-data-grant/us-parties/inventors/inventor/addressbook/address/state</code>
 +
*** example: OR
 +
** APS
 +
*** <code>INVT:STA</code>
 +
 
 +
* '''ADDRESS'''
 +
** XML v4.3-v4.5, all types
 +
*** <code>//us-bibliographic-data-grant/us-parties/inventors/inventor/addressbook/address</code>
 +
*** example:New York; M&#xe9;xico D. F.
 +
*** Example:
 +
 
 +
<nowiki>
 +
<city>Beaverton</city>
 +
<state>OR</state>
 +
<country>US</country></nowiki>
 +
 
 +
=== assignments (all are strings) ===
 +
 
 +
* '''LAST_NAME'''
 +
***No entry under ''assignee''
 +
** APS
 +
*** N/A (see '''ORG_NAME''')
 +
 
 +
* '''FIRST_NAME'''
 +
***No entry under ''assignee''
 +
** APS
 +
*** N/A (see '''ORG_NAME''')
 +
 
 +
* '''ORG_NAME'''
 +
** XML v4.5 types utility, plant, reissue; v4.4 plant, reissue, design types; v4.3  all types; v4.2 reissue, plant types; v4.1 all types; v4.0 utility and reissue types.
 +
(first listed is highest preference)
 +
*** <code>//us-bibliographic-data-grant/assignees/assignee/addressbook/orgname</code>
 +
***example: STMicroelectronics S.r.l.; Kellogg Company; Nike, Inc.
 +
** APS
 +
*** <code>ASSG:NAM</code>
 +
 
 +
* '''CITY'''
 +
** XML v4.5 types utility, plant, reissue; v4.4 plant, reissue, design types; v4.3  all types; v4.2 reissue, plant types; v4.1 all types; v4.0 reissue type.
 +
*** <code>//us-bibliographic-data-grant/assignees/assignee/addressbook/address/city</code>
 +
*** examples:
 +
****Portage
 +
****Saskatoon, Saskatchewan
 +
** APS
 +
*** <code>ASSG:CTY</code>
 +
 
 +
* '''COUNTRY'''
 +
** XML v4.5 types utility, plant, reissue; v4.4 plant, reissue, design types; v4.3  all types; v4.2 reissue, plant types; v4.1 all types; v4.0 utility and reissue types.
 +
*** <code>//us-bibliographic-data-grant/assignees/assignee/addressbook/address/country</code>
 +
*** example: US
 +
** APS
 +
*** <code>ASSG:CNT</code>
 +
 
 +
* '''STATE'''
 +
Note: foreign countries had no listed state; territories or states were included in the city listing.  For the sake of time these haven't been checked for being domestic; presumably some of these versions lack ''state'' entries.
 +
** XML v4.5 types utility, plant, reissue; v4.4 plant, reissue, design types; v4.3  all types; v4.2 reissue, plant types; v4.1 all types; v4.0 utility and reissue types.
 +
*** <code>//us-bibliographic-data-grant/assignees/assignee/addressbook/address/state</code>
 +
*** example: MD
 +
** APS
 +
*** <code>ASSG:STA</code>
 +
 
 +
* '''ADDRESS'''
 +
** XML v4.5 types utility, plant, reissue; v4.4 plant, reissue, design types; v4.3  all types; v4.2 reissue, plant types; v4.1 all types; v4.0 utility and reissue types.
 +
***<code>//us-bibliographic-data-grant/assignees/assignee/addressbook/address
 +
***examples:
 +
 
 +
<nowiki>
 +
<city>Saskatoon, Saskatchewan</city>
 +
<country>CA</country></nowiki>
 +
 
 +
<nowiki>
 +
<city>Portage</city>
 +
<state>MI</state>
 +
<country>US</country></nowiki>
 +
 
 +
** APS
 +
*** <code>ASSG:STR</code>
 +
 
 +
=== lawyers (all are strings) ===
 +
 
 +
''Note in the below queries, for XML results only those XML agent nodes with <code>rep-type="attorney"</code> are looked at.''
 +
 
 +
* '''SEQUENCE'''
 +
** XML 4.3 utility, reissue, design types, 4.4 utility, reissue, design types, 4.5 all types
 +
*** <code>//us-bibliographic-data-grant/us-parties/agents/agent/sequence</code>
 +
***example: "01"
 +
** XML 4.0 all types, 4.1 all types, 4.2 utility, reissue, plant types
 +
*** <code>//us-bibliographic-data-grant/parties/agents/agent/sequence</code>
 +
 
 +
* '''LAST_NAME'''
 +
Note: For last_name, it is possible that a certain example didn't list one, but that other examples of that type would.
 +
** XML 4.3 utility, reissue, plant types, 4.4  reissue, design types, 4.5 utility, design types
 +
*** <code>//us-bibliographic-data-grant/us-parties/agents/agent/addressbook/last-name</code>
 +
** XML 4.0 plant type, 4.1 plant, design types, 4.2 plant types(first listed is highest preference)
 +
*** <code>//us-bibliographic-data-grant/parties/agents/agent/addressbook/last-name</code>
 +
** APS
 +
*** N/A (see '''FIRST_NAME''')
 +
 
 +
* '''FIRST_NAME'''
 +
Note: For first_name, it is possible that a certain example didn't list one, but that other examples of that type would.
 +
** XML 4.3, 4.4, 4.5 utility, design types (first listed is highest preference)
 +
*** <code>//us-bibliographic-data-grant/us-parties/agents/agent/addressbook/first-name</code>
 +
** XML 4.0, 4.1, 4.2 (first listed is highest preference)
 +
*** <code>//us-bibliographic-data-grant/parties/agents/agent/addressbook/first-name</code>
 +
** APS
 +
*** <code>LREP:NAM</code> (whole name of an individual)
 +
 
 +
* '''ORG_NAME'''
 +
Note: For orgname, it is possible that a certain example didn't list one, but that other examples of that type would.
 +
** XML 4.3 utility, reissue, design, v4.4 utility, reissue, design v4.5 reissue, plant types  (first listed is highest preference)
 +
*** <code>//us-bibliographic-data-grant/us-parties/agents/agent/addressbook/orgname</code>
 +
** XML 4.0 utility, reissue, design types, 4.1 utility, reissue, 4.2 utility, reissue types (first listed is highest preference)
 +
*** <code>//us-bibliographic-data-grant/parties/agents/agent/addressbook/orgname</code>
 +
** APS
 +
*** <code>LREP:FRM</code>
 +
 
 +
No address data exists for any versions or examples:
 +
 
 +
 
 +
* '''CITY'''
 +
** XML 4.3, 4.4, 4.5
 +
*** ?
 +
** APS
 +
*** <code>LREP:CTY</code>
 +
 
 +
* '''COUNTRY'''
 +
** XML 4.3, 4.4, 4.5
 +
*** ?
 +
** APS
 +
*** <code>LREP:CNT</code>
 +
 
 +
* '''STATE'''
 +
** XML 4.3, 4.4, 4.5
 +
*** ?
 +
** APS
 +
*** <code>LREP:STA</code>
 +
 
 +
* '''ADDRESS'''
 +
** XML 4.3, 4.4, 4.5
 +
*** ?
 +
** APS
 +
*** <code>LREP:STR</code>
 +
 
 +
* '''POSTCODE'''
 +
** XML 4.3, 4.4, 4.5
 +
*** ?
 +
** APS
 +
*** <code>LREP:ZIP</code>
 +
 
 +
 
 +
===citations header===
 +
 
 +
==Applications==
 +
*The only examples in the applications folder were plant type v4.2-v4.4, and utility type v4.0-v4.4.  Two files with v1.5 and v1.6 (of unknown type) were ignored.
 +
 
 +
== Examples ==
 +
 
 +
* APS
 +
 
 +
The first APS entry of <code>E:\McNair\Projects\SimplerPatentData\data\extracts\granted\pftaps19760106_wk01.txt</code> as a GrantedPatent is
 +
 
 +
<nowiki>
 +
strings: {PCT_DOCUMENT_NUMBER=null, PATENT_NUMBER=RE0286710, PATENT_GRANT_DATE=19760106, TITLE=Hydrophone damper assembly, APPLICATION_FILING_DATE=19740826, PRIMARY_EXAMINER_FIRST_NAME=Blix; Trygve M., PATENT_TYPE=2, APPLICATION_NUMBER=500649&, PRIORITY_CLAIMS_DATE=null, PRIORITY_CLAIMS_COUNTRY=null, PRIORITY_CLAIMS_PATENT_NUMBER=null}
 +
integers: {NUMBER_OF_CLAIMS=18}
 +
extras: {class org.bakerinstitute.mcnair.models.Citation=[], class org.bakerinstitute.mcnair.models.Sciref=[], class org.bakerinstitute.mcnair.models.Inventor=[strings: {STATE=MI, ORG_NAME=Widenhofer; James W., COUNTRY=null, CITY=Jackson, ADDRESS=null, POSTCODE=null, CITING_PATENT=RE0286710}
 +
integers: {}], class org.bakerinstitute.mcnair.models.AssignmentSummary=[strings: {COUNTRY=null, CITING_PATENT=RE0286710, CITY=Jackson, POSTCODE=null, ORG_NAME=Sparton Corporation, STATE=MI}
 +
integers: {}], class org.bakerinstitute.mcnair.models.Lawyer=[strings: {FIRST_NAME=null, CITY=null, POSTCODE=null, COUNTRY=null, STATE=null, CITING_PATENT=RE0286710, ORG_NAME=Beaman & Beaman, ADDRESS=null}
 +
integers: {}]}</nowiki>
 +
 
 +
* XML 4.5
 +
 
 +
The first XML entry of <code>E:\McNair\Projects\SimplerPatentData\data\extracts\granted\ipg161227.xml</code> as a GrantedPatent is
 +
 
 +
<nowiki>
 +
strings: {CLASSIFICATION_NATIONAL_COUNTRY=US, PCT_DOCUMENT_NUMBER=, PATENT_COUNTRY=US, APPLICATION_FILING_DATE=20150422, PRIMARY_EXAMINER_FIRST_NAME=Karen, PATENT_NUMBER=, PRIMARY_EXAMINER_LAST_NAME=Kearney, PATENT_KIND=, CLASSIFICATION_NATIONAL_CLASS=D 2614, PATENT_TYPE=design, PATENT_GRANT_DATE=20161227, APPLICATION_NUMBER=29524659, PRIMARY_EXAMINER_DEPARTMENT=2923, TITLE=Smart sports glove}
 +
integers: {NUMBER_OF_CLAIMS=1}
 +
extras: {class org.bakerinstitute.mcnair.models.Citation=[strings: {CITED_PATENT_NUMBER=4051552, CITED_PATENT_CATEGORY=, CITED_PATENT_KIND=A, CITING_PATENT=D0774723, CITED_PATENT_COUNTRY=US}
 +
integers: {}, strings: {CITED_PATENT_NUMBER=6016103, CITED_PATENT_CATEGORY=, CITED_PATENT_KIND=A, CITING_PATENT=D0774723, CITED_PATENT_COUNTRY=US}
 +
integers: {}, strings: {CITED_PATENT_NUMBER=D512549, CITED_PATENT_CATEGORY=, CITED_PATENT_KIND=S, CITING_PATENT=D0774723, CITED_PATENT_COUNTRY=US}
 +
integers: {}, strings: {CITED_PATENT_NUMBER=9189022, CITED_PATENT_CATEGORY=, CITED_PATENT_KIND=B2, CITING_PATENT=D0774723, CITED_PATENT_COUNTRY=US}
 +
integers: {}, strings: {CITED_PATENT_NUMBER=2009/0323316, CITED_PATENT_CATEGORY=, CITED_PATENT_KIND=A1, CITING_PATENT=D0774723, CITED_PATENT_COUNTRY=US}
 +
integers: {}, strings: {CITED_PATENT_NUMBER=2012/0069552, CITED_PATENT_CATEGORY=, CITED_PATENT_KIND=A1, CITING_PATENT=D0774723, CITED_PATENT_COUNTRY=US}
 +
integers: {}, strings: {CITED_PATENT_NUMBER=2012/0081884, CITED_PATENT_CATEGORY=, CITED_PATENT_KIND=A1, CITING_PATENT=D0774723, CITED_PATENT_COUNTRY=US}
 +
integers: {}, strings: {CITED_PATENT_NUMBER=2013/0184092, CITED_PATENT_CATEGORY=, CITED_PATENT_KIND=A1, CITING_PATENT=D0774723, CITED_PATENT_COUNTRY=US}
 +
integers: {}, strings: {CITED_PATENT_NUMBER=2015/0157065, CITED_PATENT_CATEGORY=, CITED_PATENT_KIND=A1, CITING_PATENT=D0774723, CITED_PATENT_COUNTRY=US}
 +
integers: {}, strings: {CITED_PATENT_NUMBER=2015/0237181, CITED_PATENT_CATEGORY=, CITED_PATENT_KIND=A1, CITING_PATENT=D0774723, CITED_PATENT_COUNTRY=US}
 +
integers: {}], class org.bakerinstitute.mcnair.models.Sciref=[strings: {CITING_PATENT=D0774723, CITATION_DESCRIPTION=Cheat Code Central | Extra | Predictions | Video Game Foresight—Power Glove 2, posted on Feb. 10, 2011, © 1997-2016 Cheat Code Central [online], [site visited Aug. 15, 2016]. Available from Internet, <URL: http://www.cheatcc.com/extra/predictions-powerglove.html>.}
 +
integers: {}, strings: {CITING_PATENT=D0774723, CITATION_DESCRIPTION=Lazure | 2014: A bleeding edge effort in chips . . . , posted on Dec. 11, 2014, no copyright date posted [online], [site visited Aug. 17, 2016]. Available from Internet, <URL: https://lazure2.wordpress.com>.}
 +
integers: {}, strings: {CITING_PATENT=D0774723, CITATION_DESCRIPTION=SoyaCincau | 2014 | 04 | 01 | Samsung Fingers Smart Glove with Flexible Display, posted on Apr. 1, 2014, © 2016 SoyaCincau.com [online], [site visited Aug. 17, 2016]. Available from Internet, <URL: http://www.soyacincau.com/2014/04/01/samsung-fingers-smart-glove-with-flexible-display/>.}
 +
integers: {}, strings: {CITING_PATENT=D0774723, CITATION_DESCRIPTION=Tech Ticking | 2014 | 12 | Top 10 of the Best 2014 Wearables, posted by Rami Raouagi on Dec. 19, 2014, © 2016 Tech Ticking [online], [site visited Aug. 17, 2016]. Available from Internet, <URL: http://www.techticking.com/2014/12/top-10-of-best-2014-wearables.html/>.}
 +
integers: {}], class org.bakerinstitute.mcnair.models.Inventor=[strings: {ORG_NAME=, CITING_PATENT=D0774723, LAST_NAME=Daniel, FIRST_NAME=Isaac S., SEQUENCE=}
 +
integers: {}], class org.bakerinstitute.mcnair.models.AssignmentSummary=[], class org.bakerinstitute.mcnair.models.Lawyer=[]}</nowiki>

Latest revision as of 12:47, 21 September 2020


Project
Equivalent XPath and APS Queries
Project logo 02.png
Project Information
Has title Equivalent XPath and APS Queries
Has owner Oliver Chang, Ed Egan
Has start date June 2017
Has deadline date
Has project status Tabled
Has sponsor McNair Center
Has project output Tool
Copyright © 2019 edegan.com. All Rights Reserved.


Current Status for Granted Patents implementation


How it works currently

Only has the intelligence from E:\McNair\PatentData\Processed\xmlparser_4.5_4.4_4.3.pl. That is to say, it only explicitly covers versions 4.3, 4.4, and 4.5 utility patents. Plant, reissue, and design patents contain a nonempty intersection with these attributes but have their own quirks. The actual code to do this XML parsing is at E:\McNair\Projects\SimplerPatentData\src\main\java\org\bakerinstitute\mcnair\uspto_granted\XmlParser.java with the end goal to create an in-memory representation of a granted patent as a E:\McNair\Projects\SimplerPatentData\src\main\java\org\bakerinstitute\mcnair\models\GrantedPatent.java data structure.

To learn about the fields that a model contains, look at the class Model.Metadata which should implement interface TableMetadata. In particular, this bunch of constant data describes the mapping of enum fields to table column names as well as the types of columns.

For an example, we can tell that GrantedPatent is a struct that contains the following data:

private final Map<GrantedPatent.Fields, String> strings;
private final Map<GrantedPatent.Fields, Double> numbers;
private final List<Citation> citations;
private final List<Sciref> scirefs;
private final List<Inventor> inventors;
private final List<AssignmentSummary> assignments;
private final List<Lawyer> lawyers;

Query Equivalences

Note: xpaths are for all design types (utility, reissue, plant, design) unless otherwise noted. Only granted patents have been checked so far.

Notes to remember:

All the text under each text file in E:\McNair\Projects\SimplerPatentData\data\examples\granted appears under the following lines of text, indicating that every XML should perhaps include these headers (the headers aren't closed anywhere in the text files in E:\McNair\Projects\SimplerPatentData\data\examples\granted; for example, there's no </us-patent-grant> towards the end of the text file.

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE us-patent-grant SYSTEM "us-patent-grant-v45-2014-04-03.dtd" [ ]>
<us-patent-grant 

Ignoring the above three lines for every text file (changes to XMLs can be made later with RegEx), the XMLs for sequence, and last-name, respectively, from the lines of code below it are:

//us-bibliographic-data-grant/inventors/inventor/@sequence
//us-bibliographic-data-grant/inventors/inventor/addressbook/last-name
<inventors>
<inventor sequence="001" designation="us-only">
<addressbook>
<last-name>Kobelt</last-name>
<first-name>Markus</first-name>
<address>
<city>Buchs</city>
<country>CH</country>
</address>
</addressbook>
</inventor>


Also note: the lack of a certain entry for a certain version and type simply means that it was missing from the single example located in the E:\McNair\Projects\SimplerPatentData\data\examples\Patent Schema Reconciliation\granted file. The presence or lack of a certain entry could mean either that it is missing systematically (and would presumably be missing for all other examples of that version and type), or simply that that single example, in contrast to other examples for that version and type, lacked an entry.


Granted

strings

  • PATENT_TYPE
    • XML 4.0, 4.1, 4.2, 4.3, 4.4, 4.5
      • //us-bibliographic-data-grant/application-reference/@appl-type
      • example: utility
    • APS
      • PATN:APT
  • TITLE
    • XML 4.0, 4.1, 4.2, 4.3, 4.4, 4.5
      • //us-bibliographic-data-grant/invention-title
      • example: Seeding implement depth adjustment mechanism
    • APS
      • PATN:TTL
  • PCT_DOCUMENT_NUMBER
    • only for XML 4.0 utility, 4.2 utility, 4.3 reissue
      • //us-bibliographic-data-grant/pct-or-regional-filing-data/document-id/doc-number
      • example: PCT/IT03/00298
    • APS
      • PCTA:PCN
  • PATENT_COUNTRY
    • XML 4.0, 4.1, 4.2, 4.3, 4.4, 4.5
      • //us-bibliographic-data-grant/publication-reference/document-id/country
      • example: US
    • APS
      •  ?
  • PATENT_NUMBER
    • XML 4.0, 4.1, 4.2, 4.3, 4.4, 4.5
      • //us-bibliographic-data-grant/publication-reference/document-id/doc-number
      • example: 09521796
    • APS
      • PATN:WKU
  • PATENT_KIND
    • XML 4.0, 4.1, 4.2, 4.3, 4.4, 4.5
      • //us-bibliographic-data-grant/publication-reference/document-id/kind
      • example: B2
    • APS
      •  ?
  • PATENT_GRANT_DATE
    • XML 4.0, 4.1, 4.2, 4.3, 4.4, 4.5
      • //us-bibliographic-data-grant/publication-reference/document-id/date
      • example: 20161220
    • APS
      • PATN:ISD
  • APPLICATION_NUMBER
    • XML 4.0, 4.1, 4.2, 4.3, 4.4, 4.5
      • //us-bibliographic-data-grant/application-reference/document-id/doc-number
      • example: 14182202
    • APS
      • PATN:APN
  • APPLICATION_FILING_DATE
    • XML 4.0, 4.1, 4.2, 4.3, 4.4, 4.5
      • //us-bibliographic-data-grant/application-reference/document-id/date
      • example: 20140217
    • APS
      • PATN:APD
  • PRIORITY_CLAIMS_DATE
    • XML 4.0 only design, reissue, and utility types, 4.1 only utility type, 4.2 only utility type, 4.4 only reissue type
      • //us-bibliographic-data-grant/priority-claims/priority-claim/date
      • example: 20000330
    • APS
      • PRIR:APD
  • PRIORITY_CLAIMS_COUNTRY
    • XML 4.0 only design, reissue, and utility types, 4.1 only utility type, 4.2 only utility type, 4.4 only reissue type
      • //us-bibliographic-data-grant/priority-claims/priority-claim/country
      • example: GB
    • APS
      • PRIR:CNT
  • PRIORITY_CLAIMS_PATENT_NUMBER
    • XML 4.0 only design, reissue, and utility types, 4.1 only utility type, 4.2 only utility type, 4.4 only reissue type
      • //us-bibliographic-data-grant/priority-claims/priority-claim/doc-number
      • example: 0007806.3
    • APS
      • PRIR:APN
  • IPCR_SUBCLASS
    • XML 4.1, 4.2, 4.3, 4.4 and 4.5, only for plant, reissue, and utility types
      • //us-bibliographic-data-grant/classifications-ipcr/classification-ipcr/subclass
      • example: C
    • APS
      •  ?
  • IPCR_MAIN_GROUP
    • XML 4.1, 4.2, 4.3, 4.4 and 4.5, only for plant, reissue, and utility types
      • //us-bibliographic-data-grant/classifications-ipcr/classification-ipcr/main-group
      • example: 11
    • APS
      •  ?
  • IPCR_SUB_GROUP
    • XML 4.1, 4.2, 4.3, 4.4 and 4.5, only for plant, reissue, and utility types
      • //us-bibliographic-data-grant/classifications-ipcr/classification-ipcr/subgroup
      • example: 00
    • APS
      •  ?
  • CPC_SUBCLASS
    • for XML 4.5 utility, reissue types
      • //us-bibliographic-data-grant/classifications-cpc/main-cpc/classification-cpc/subclass

example: C

    • APS
      •  ?
  • CPC_MAIN_GROUP
    • XML 4.5 types utility, reissue types
      • //us-bibliographic-data-grant/classifications-cpc/main-cpc/classification-cpc/main-group
      • example: 49
    • APS
      •  ?
  • CPC_SUB_GROUP
    • XML 4.5 types utility, reissue types
      • //us-bibliographic-data-grant/classifications-cpc/main-cpc/classification-cpc/subgroup
      • example: 027
    • APS
      •  ?
  • CLASSIFICATION_NATIONAL_COUNTRY
    • XML 4.0, (first listed is highest preference)
      • //us-bibliographic-data-grant/classification-national/country
      • example: US
    • XML 4.1, 4.2, 4.3, 4.4, 4.5
      • //us-bibliographic-data-grant/us-field-of-classification-search/classification-national/country
      • example: US
    • APS
      •  ?
  • CLASSIFICATION_NATIONAL_CLASS
    • XML 4.0, 4.1, 4.2, 4.3, 4.4, 4.5 (first listed is highest preference)
      • //us-bibliographic-data-grant/classification-national/main-classification
      • examples:
        • for v4.5 utility: 172610
        • for v4.5 reissue type: 16250
        • for v4.5 plant type: PLT161
        • for v4.5 design type: 2159, D30158, D 2614
        • for v4.4 utility type: 2 85, 2126
        • for v4.4 reissue type: 248415, 211 47, 2482821
        • for v4.4 plant type: PLT104
        • for v4.4 design type: 0101
        • for v4.3 utility type: 2159, 40615, 430 1
        • for v4.3 reissue type: 257341, 257328-377, 257E29076
        • for v4.3 plant type: PLT115
        • for v4.3 design type: 0101, D 1107, D 75513, D20 29, D 1100-199, D11108
        • for v4.2 utility type: 92140, 277444
        • for v4.2 reissue type: 134 21, 15345, 8158
        • for v4.2 plant type: PLT 308
        • for v4.2 design type: 0202, D 2719, 2113, 2 695, 2 69,
        • for v4.1 utility type: 453 33, 453 3, 453 10- 13
        • for v4.1 reissue type: 700241, 340 59, 377 7, 700230-238, 34082535
        • for v4.1 plant type: PLT373,
        • for v4.1 design type: 0101, D 1125, 426390, 4251311, 426 95, D 1100- 30, D11 6, D11 13, D11 17- 8, D11 20, 426103- 4, D21672, 264 75
        • for v40 utility type: F01L 134, 123 9016, 123 906, 74 53, 74567
        • for v40 reissue type: A61B 5024, 600519, 600515-517, 607 4, 607 14
        • for v40 plant type: A01H 500, PLT318
        • for v40 design type: 0206, D 2617, 2159, D291171, D29113, D29122-123, D 2613-621, 2 16, 21161-1168
    • APS
      •  ?
  • PRIMARY_EXAMINER_FIRST_NAME
    • XML 4.0, 4.1, 4.2, 4.3, 4.4, 4.5
      • //us-bibliographic-data-grant/examiners/primary-examiner/first-name
      • examples:
        • For v4.5, Christopher
        • For v4.2-v4.4, Deanna L, Karen
        • For v4.0-v4.1, Donald P., Kent
    • APS
      • PATN:EXP (whole name)
  • PRIMARY_EXAMINER_LAST_NAME
    • XML 4.0, 4.1, 4.2, 4.3, 4.4, 4.5
      • //us-bibliographic-data-grant/examiners/primary-examiner/last-name
      • example: Novosad
    • APS
      • N/A (PATN:EXP has whole name)
  • PRIMARY_EXAMINER_DEPARTMENT
    • XML 4.0, 4.1, 4.2, 4.3, 4.4, 4.5
      • //us-bibliographic-data-grant/examiners/primary-examiner/department
      • example: 3745
    • APS
      •  ?

numbers

  • NUMBER_OF_CLAIMS
    • XML 4.0, 4.1, 4.2, 4.3, 4.4, 4.5
      • //us-bibliographic-data-grant/number-of-claims
      • example : 10
    • APS
      • PATN:NCL

applicants

  • SEQUENCE
    • XML 4.3, 4.4, 4.5
      • //us-bibliographic-data-grant/us-parties/us-applicants/us-applicant/sequence
      • example: "001"
    • XML 4.0, 4.1, 4.2
      • //us-bibliographic-data-grant/parties/applicants/applicant/sequence
      • example: "001"
    • APS
      •  ?
  • LAST_NAME
    • XML 4.3, 4.4, 4.5
      • //us-bibliographic-data-grant/us-parties/us-applicants/us-applicant/addressbook/last-name
      • example: Maas
    • XML 4.0, 4.1, 4.2
      • //us-bibliographic-data-grant/parties/applicants/applicant/addressbook/last-name
      • example: Ryder
    • APS
      • N/A (see ORG_NAME)
  • FIRST_NAME
    • XML 4.3, 4.4, 4.5
      • //us-bibliographic-data-grant/us-parties/us-applicants/us-applicant/addressbook/first-name
      • example: Nicholas George Alfred, Kevin
    • XML 4.0, 4.1, 4.2
      • //us-bibliographic-data-grant/parties/applicants/applicant/addressbook/first-name
      • example: Gerhard
    • APS
      • N/A (see ORG_NAME)
  • ORG_NAME
    • XML v4.5 utility, reissue, plant
      • //us-bibliographic-data-grant/us-parties/us-applicants/us-applicant/addressbook/orgname
      • examples: W. Kordes' Söhne Rosenschulen GmbH & Co KG [this is one example, included to show the variety of characters/symbols included in orgnames]
      • INVT:NAM (whole name, might be of an individual)
  • CITY
    • XML v4.3-v4.5, all types
      • //us-bibliographic-data-grant/us-parties/us-applicants/us-applicant/addressbook/address/city
      • example:New York; México D. F.
    • XML v4.0-v4.2
      • //us-bibliographic-data-grant/parties/applicants/applicant/addressbook/address/city
    • APS
      • INVT:CTY
  • COUNTRY
    • XML v4.3-v4.5, all types
      • //us-bibliographic-data-grant/us-parties/us-applicants/us-applicant/addressbook/address/country
      • example:New York; México D. F.
    • XML v4.0-v4.2, all types
      • //us-bibliographic-data-grant/parties/applicants/applicant/addressbook/address/country
    • APS
      • INVT:CNT
  • STATE
    • XML v4.3-v4.5, all types
      • //us-bibliographic-data-grant/us-parties/us-applicants/us-applicant/addressbook/address/state
      • example:New York; México D. F.
    • XML v4.0-v4.2, all types
      • //us-bibliographic-data-grant/parties/applicants/applicant/addressbook/address/state
    • APS
      • INVT:STA
  • ADDRESS
    • XML v4.3-v4.5, all types
      • //us-bibliographic-data-grant/us-parties/us-applicants/us-applicant/addressbook/address
      • example:New York; México D. F.
    • XML v4.0-v4.2, all types
      • //us-bibliographic-data-grant/parties/applicants/applicant/addressbook/address
      • Examples:
<city>London</city>
<country>GB</country>
<city>Coraopolis</city>
<state>PA</state>
<country>US</country>
  • POSTCODE
    • XML v4.2 design
      • Example: //us-bibliographic-data-grant/parties/applicants/applicant/addressbook/address/postcode
    • APS
      • INVT:ZIP

scirefs (all are strings-unsure??)

Citations

  • CITATION_DESCRIPTION
    • XML 4.3 design type, 4.4 reissue type, 4.5 all types
      • //us-bibliographic-data-grant/us-references-cited/us-citation/nplcit/othercit
      • examples:
        • www.bikesomewhere.com/bikesomewhere.cfm/product/7/4138/15270
        • Photograph that is representative of an angle-cut tip for a continuous geared hinge that was publicly used or on sale more than one (1) year prior to the filing date of U.S. Appl. No. 61/231,249, filed Aug. 4, 2009.
    • XML 4.0 reissue type, 4.1 plant type, 4.2 all types
    • APS
      •  ?
  • CITATION NUMBER
    • XML v4.3-v4.5, design, reissue and utility types
      • //us-bibliographic-data-grant/us-references-cited/us-citation/patcit/num
      • example: "00001"
    • XML v4.0-v4.2, design, reissue and utility types
      • example: "00001"
      • //us-bibliographic-data-grant/references-cited/citation/patcit/num


  • NPL CITATION NUMBER
    • XML v4.5, v4.4 reissue, v4.3 design
      • //us-bibliographic-data-grant/us-references-cited/us-citation/nplcit/num
      • example:"00017"
    • XML v4.2 utility, reissue, design types, 4.1 plant type, v4.0 reissue type
      • //us-bibliographic-data-grant/references-cited/citation/nplcit/num
      • example: "00007"
  • COUNTRY
    • XML v4.3-v4,5 design, reissue, utility types
      • //us-bibliographic-data-grant/us-references-cited/us-citation/patcit/document-id/country>
      • example: US
    • XML v4.0-v4.2 design, reissue, utility types
      • //us-bibliographic-data-grant/references-cited/citation/patcit/document-id/country>
      • example: US
  • CITATIONS DOC NUMBER
    • XML v4.3-v4.5 design, reissue, utility types
      • //us-bibliographic-data-grant/us-references-cited/us-citation/patcit/document-id/doc-number>
      • example: 19830700
    • XML v4.0-v4.2 design, reissue, utility types
      • //us-bibliographic-data-grant/references-cited/citation/patcit/document-id/doc-number>
      • example: 4393877
  • CITATIONS KIND
    • XML v4.3-v4.5 design, reissue, utility types
      • //us-bibliographic-data-grant/us-references-cited/us-citation/patcit/document-id/kind>
      • example: B1
    • XML v4.0-v4.2 design, reissue, utility types
      • //us-bibliographic-data-grant/references-cited/citation/patcit/document-id/kind>
      • example: A
  • CITATIONS NAME
    • XML v4.3-v4.5 design, reissue, utility types
      • //us-bibliographic-data-grant/us-references-cited/us-citation/patcit/document-id/name>
      • example: Prairie et al.
    • XML v4.0-v4.2 design, reissue, utility types
      • //us-bibliographic-data-grant/references-cited/citation/patcit/document-id/name>
      • example: Imran et al.
  • CITATIONS DATE
    • XML v4.3-v4.5 design, reissue, utility types
      • //us-bibliographic-data-grant/us-references-cited/us-citation/patcit/document-id/date>
      • example: 20020500
    • XML v4.0-v4.2 design, reissue, utility types
      • //us-bibliographic-data-grant/references-cited/citation/patcit/document-id/date>
      • example: 19830700

inventors (all are strings)

  • SEQUENCE
    • XML 4.3, 4.4, 4.5, all types
      • //us-bibliographic-data-grant/us-parties/inventors/inventor/sequence
      • examples: "001"; "002"
    • APS
      •  ?
  • LAST_NAME
    • XML 4.3, 4.4, 4.5, all types
      • //us-bibliographic-data-grant/us-parties/inventors/inventor/addressbook/last-name
      • example: Maas
    • APS
      • N/A (see ORG_NAME)
  • FIRST_NAME
    • XML 4.3, 4.4, 4.5, all types
      • //us-bibliographic-data-grant/us-parties/inventors/inventor/addressbook/first-name
      • example: Nicholas George Alfred, Kevin
    • APS
      • N/A (see ORG_NAME)


  • CITY
    • XML v4.3-v4.5, all types
      • //us-bibliographic-data-grant/us-parties/inventors/inventor/addressbook/address/city
      • example: Beaverton
    • APS
      • INVT:CTY
  • COUNTRY
    • XML v4.3-v4.5, all types
      • //us-bibliographic-data-grant/us-parties/inventors/inventor/addressbook/address/country
      • example: US
    • APS
      • INVT:CNT
  • STATE
    • XML v4.3-v4.5, all types
      • //us-bibliographic-data-grant/us-parties/inventors/inventor/addressbook/address/state
      • example: OR
    • APS
      • INVT:STA
  • ADDRESS
    • XML v4.3-v4.5, all types
      • //us-bibliographic-data-grant/us-parties/inventors/inventor/addressbook/address
      • example:New York; México D. F.
      • Example:
<city>Beaverton</city>
<state>OR</state>
<country>US</country>

assignments (all are strings)

  • LAST_NAME
      • No entry under assignee
    • APS
      • N/A (see ORG_NAME)
  • FIRST_NAME
      • No entry under assignee
    • APS
      • N/A (see ORG_NAME)
  • ORG_NAME
    • XML v4.5 types utility, plant, reissue; v4.4 plant, reissue, design types; v4.3 all types; v4.2 reissue, plant types; v4.1 all types; v4.0 utility and reissue types.

(first listed is highest preference)

      • //us-bibliographic-data-grant/assignees/assignee/addressbook/orgname
      • example: STMicroelectronics S.r.l.; Kellogg Company; Nike, Inc.
    • APS
      • ASSG:NAM
  • CITY
    • XML v4.5 types utility, plant, reissue; v4.4 plant, reissue, design types; v4.3 all types; v4.2 reissue, plant types; v4.1 all types; v4.0 reissue type.
      • //us-bibliographic-data-grant/assignees/assignee/addressbook/address/city
      • examples:
        • Portage
        • Saskatoon, Saskatchewan
    • APS
      • ASSG:CTY
  • COUNTRY
    • XML v4.5 types utility, plant, reissue; v4.4 plant, reissue, design types; v4.3 all types; v4.2 reissue, plant types; v4.1 all types; v4.0 utility and reissue types.
      • //us-bibliographic-data-grant/assignees/assignee/addressbook/address/country
      • example: US
    • APS
      • ASSG:CNT
  • STATE

Note: foreign countries had no listed state; territories or states were included in the city listing. For the sake of time these haven't been checked for being domestic; presumably some of these versions lack state entries.

    • XML v4.5 types utility, plant, reissue; v4.4 plant, reissue, design types; v4.3 all types; v4.2 reissue, plant types; v4.1 all types; v4.0 utility and reissue types.
      • //us-bibliographic-data-grant/assignees/assignee/addressbook/address/state
      • example: MD
    • APS
      • ASSG:STA
  • ADDRESS
    • XML v4.5 types utility, plant, reissue; v4.4 plant, reissue, design types; v4.3 all types; v4.2 reissue, plant types; v4.1 all types; v4.0 utility and reissue types.
      • //us-bibliographic-data-grant/assignees/assignee/addressbook/address
      • examples:
<city>Saskatoon, Saskatchewan</city>
<country>CA</country>
<city>Portage</city>
<state>MI</state>
<country>US</country>
    • APS
      • ASSG:STR

lawyers (all are strings)

Note in the below queries, for XML results only those XML agent nodes with rep-type="attorney" are looked at.

  • SEQUENCE
    • XML 4.3 utility, reissue, design types, 4.4 utility, reissue, design types, 4.5 all types
      • //us-bibliographic-data-grant/us-parties/agents/agent/sequence
      • example: "01"
    • XML 4.0 all types, 4.1 all types, 4.2 utility, reissue, plant types
      • //us-bibliographic-data-grant/parties/agents/agent/sequence
  • LAST_NAME

Note: For last_name, it is possible that a certain example didn't list one, but that other examples of that type would.

    • XML 4.3 utility, reissue, plant types, 4.4 reissue, design types, 4.5 utility, design types
      • //us-bibliographic-data-grant/us-parties/agents/agent/addressbook/last-name
    • XML 4.0 plant type, 4.1 plant, design types, 4.2 plant types(first listed is highest preference)
      • //us-bibliographic-data-grant/parties/agents/agent/addressbook/last-name
    • APS
      • N/A (see FIRST_NAME)
  • FIRST_NAME

Note: For first_name, it is possible that a certain example didn't list one, but that other examples of that type would.

    • XML 4.3, 4.4, 4.5 utility, design types (first listed is highest preference)
      • //us-bibliographic-data-grant/us-parties/agents/agent/addressbook/first-name
    • XML 4.0, 4.1, 4.2 (first listed is highest preference)
      • //us-bibliographic-data-grant/parties/agents/agent/addressbook/first-name
    • APS
      • LREP:NAM (whole name of an individual)
  • ORG_NAME

Note: For orgname, it is possible that a certain example didn't list one, but that other examples of that type would.

    • XML 4.3 utility, reissue, design, v4.4 utility, reissue, design v4.5 reissue, plant types (first listed is highest preference)
      • //us-bibliographic-data-grant/us-parties/agents/agent/addressbook/orgname
    • XML 4.0 utility, reissue, design types, 4.1 utility, reissue, 4.2 utility, reissue types (first listed is highest preference)
      • //us-bibliographic-data-grant/parties/agents/agent/addressbook/orgname
    • APS
      • LREP:FRM

No address data exists for any versions or examples:


  • CITY
    • XML 4.3, 4.4, 4.5
      •  ?
    • APS
      • LREP:CTY
  • COUNTRY
    • XML 4.3, 4.4, 4.5
      •  ?
    • APS
      • LREP:CNT
  • STATE
    • XML 4.3, 4.4, 4.5
      •  ?
    • APS
      • LREP:STA
  • ADDRESS
    • XML 4.3, 4.4, 4.5
      •  ?
    • APS
      • LREP:STR
  • POSTCODE
    • XML 4.3, 4.4, 4.5
      •  ?
    • APS
      • LREP:ZIP


citations header

Applications

  • The only examples in the applications folder were plant type v4.2-v4.4, and utility type v4.0-v4.4. Two files with v1.5 and v1.6 (of unknown type) were ignored.

Examples

  • APS

The first APS entry of E:\McNair\Projects\SimplerPatentData\data\extracts\granted\pftaps19760106_wk01.txt as a GrantedPatent is

strings: {PCT_DOCUMENT_NUMBER=null, PATENT_NUMBER=RE0286710, PATENT_GRANT_DATE=19760106, TITLE=Hydrophone damper assembly, APPLICATION_FILING_DATE=19740826, PRIMARY_EXAMINER_FIRST_NAME=Blix; Trygve M., PATENT_TYPE=2, APPLICATION_NUMBER=500649&, PRIORITY_CLAIMS_DATE=null, PRIORITY_CLAIMS_COUNTRY=null, PRIORITY_CLAIMS_PATENT_NUMBER=null}
integers: {NUMBER_OF_CLAIMS=18}
extras: {class org.bakerinstitute.mcnair.models.Citation=[], class org.bakerinstitute.mcnair.models.Sciref=[], class org.bakerinstitute.mcnair.models.Inventor=[strings: {STATE=MI, ORG_NAME=Widenhofer; James W., COUNTRY=null, CITY=Jackson, ADDRESS=null, POSTCODE=null, CITING_PATENT=RE0286710}
integers: {}], class org.bakerinstitute.mcnair.models.AssignmentSummary=[strings: {COUNTRY=null, CITING_PATENT=RE0286710, CITY=Jackson, POSTCODE=null, ORG_NAME=Sparton Corporation, STATE=MI}
integers: {}], class org.bakerinstitute.mcnair.models.Lawyer=[strings: {FIRST_NAME=null, CITY=null, POSTCODE=null, COUNTRY=null, STATE=null, CITING_PATENT=RE0286710, ORG_NAME=Beaman & Beaman, ADDRESS=null}
integers: {}]}
  • XML 4.5

The first XML entry of E:\McNair\Projects\SimplerPatentData\data\extracts\granted\ipg161227.xml as a GrantedPatent is

strings: {CLASSIFICATION_NATIONAL_COUNTRY=US, PCT_DOCUMENT_NUMBER=, PATENT_COUNTRY=US, APPLICATION_FILING_DATE=20150422, PRIMARY_EXAMINER_FIRST_NAME=Karen, PATENT_NUMBER=, PRIMARY_EXAMINER_LAST_NAME=Kearney, PATENT_KIND=, CLASSIFICATION_NATIONAL_CLASS=D 2614, PATENT_TYPE=design, PATENT_GRANT_DATE=20161227, APPLICATION_NUMBER=29524659, PRIMARY_EXAMINER_DEPARTMENT=2923, TITLE=Smart sports glove}
integers: {NUMBER_OF_CLAIMS=1}
extras: {class org.bakerinstitute.mcnair.models.Citation=[strings: {CITED_PATENT_NUMBER=4051552, CITED_PATENT_CATEGORY=, CITED_PATENT_KIND=A, CITING_PATENT=D0774723, CITED_PATENT_COUNTRY=US}
integers: {}, strings: {CITED_PATENT_NUMBER=6016103, CITED_PATENT_CATEGORY=, CITED_PATENT_KIND=A, CITING_PATENT=D0774723, CITED_PATENT_COUNTRY=US}
integers: {}, strings: {CITED_PATENT_NUMBER=D512549, CITED_PATENT_CATEGORY=, CITED_PATENT_KIND=S, CITING_PATENT=D0774723, CITED_PATENT_COUNTRY=US}
integers: {}, strings: {CITED_PATENT_NUMBER=9189022, CITED_PATENT_CATEGORY=, CITED_PATENT_KIND=B2, CITING_PATENT=D0774723, CITED_PATENT_COUNTRY=US}
integers: {}, strings: {CITED_PATENT_NUMBER=2009/0323316, CITED_PATENT_CATEGORY=, CITED_PATENT_KIND=A1, CITING_PATENT=D0774723, CITED_PATENT_COUNTRY=US}
integers: {}, strings: {CITED_PATENT_NUMBER=2012/0069552, CITED_PATENT_CATEGORY=, CITED_PATENT_KIND=A1, CITING_PATENT=D0774723, CITED_PATENT_COUNTRY=US}
integers: {}, strings: {CITED_PATENT_NUMBER=2012/0081884, CITED_PATENT_CATEGORY=, CITED_PATENT_KIND=A1, CITING_PATENT=D0774723, CITED_PATENT_COUNTRY=US}
integers: {}, strings: {CITED_PATENT_NUMBER=2013/0184092, CITED_PATENT_CATEGORY=, CITED_PATENT_KIND=A1, CITING_PATENT=D0774723, CITED_PATENT_COUNTRY=US}
integers: {}, strings: {CITED_PATENT_NUMBER=2015/0157065, CITED_PATENT_CATEGORY=, CITED_PATENT_KIND=A1, CITING_PATENT=D0774723, CITED_PATENT_COUNTRY=US}
integers: {}, strings: {CITED_PATENT_NUMBER=2015/0237181, CITED_PATENT_CATEGORY=, CITED_PATENT_KIND=A1, CITING_PATENT=D0774723, CITED_PATENT_COUNTRY=US}
integers: {}], class org.bakerinstitute.mcnair.models.Sciref=[strings: {CITING_PATENT=D0774723, CITATION_DESCRIPTION=Cheat Code Central | Extra | Predictions | Video Game Foresight—Power Glove 2, posted on Feb. 10, 2011, © 1997-2016 Cheat Code Central [online], [site visited Aug. 15, 2016]. Available from Internet, <URL: http://www.cheatcc.com/extra/predictions-powerglove.html>.}
integers: {}, strings: {CITING_PATENT=D0774723, CITATION_DESCRIPTION=Lazure | 2014: A bleeding edge effort in chips . . . , posted on Dec. 11, 2014, no copyright date posted [online], [site visited Aug. 17, 2016]. Available from Internet, <URL: https://lazure2.wordpress.com>.}
integers: {}, strings: {CITING_PATENT=D0774723, CITATION_DESCRIPTION=SoyaCincau | 2014 | 04 | 01 | Samsung Fingers Smart Glove with Flexible Display, posted on Apr. 1, 2014, © 2016 SoyaCincau.com [online], [site visited Aug. 17, 2016]. Available from Internet, <URL: http://www.soyacincau.com/2014/04/01/samsung-fingers-smart-glove-with-flexible-display/>.}
integers: {}, strings: {CITING_PATENT=D0774723, CITATION_DESCRIPTION=Tech Ticking | 2014 | 12 | Top 10 of the Best 2014 Wearables, posted by Rami Raouagi on Dec. 19, 2014, © 2016 Tech Ticking [online], [site visited Aug. 17, 2016]. Available from Internet, <URL: http://www.techticking.com/2014/12/top-10-of-best-2014-wearables.html/>.}
integers: {}], class org.bakerinstitute.mcnair.models.Inventor=[strings: {ORG_NAME=, CITING_PATENT=D0774723, LAST_NAME=Daniel, FIRST_NAME=Isaac S., SEQUENCE=}
integers: {}], class org.bakerinstitute.mcnair.models.AssignmentSummary=[], class org.bakerinstitute.mcnair.models.Lawyer=[]}