├── .dockerignore
├── .ebignore
├── .gitignore
├── LICENSE
├── README.md
├── _config.yml
├── querymodule
    ├── DBScripts
    │   └── PVSupport.sql
    ├── app
    │   ├── APILoggingConfigurator.php
    │   ├── AddEmailDatabase.php
    │   ├── DatabaseQuery.php
    │   ├── ErrorHandler.php
    │   ├── Exceptions
    │   │   ├── APIError.php
    │   │   ├── APIException.php
    │   │   ├── ParsingException.php
    │   │   ├── QueryException.php
    │   │   └── RequestException.php
    │   ├── QueryParser.php
    │   ├── convertDBResultsToNestedStructure.php
    │   ├── entitySpecs.php
    │   ├── executeQuery.php
    │   ├── logger_config.xml
    │   ├── routes
    │   │   ├── query.php
    │   │   └── routeUtilites.php
    │   └── specs
    │   │   ├── assignee-entity-specs.json
    │   │   ├── assignee-field-specs.json
    │   │   ├── cpc-entity-specs.json
    │   │   ├── cpc-field-specs.json
    │   │   ├── cpc-group-entity-specs.json
    │   │   ├── cpc-group-field-specs.json
    │   │   ├── inventor-entity-specs.json
    │   │   ├── inventor-field-specs.json
    │   │   ├── location-entity-specs.json
    │   │   ├── location-field-specs.json
    │   │   ├── nber-entity-specs.json
    │   │   ├── nber-field-specs.json
    │   │   ├── patent-entity-specs.json
    │   │   ├── patent-field-specs.json
    │   │   ├── uspc-entity-specs.json
    │   │   └── uspc-field-specs.json
    ├── composer.json
    ├── composer.lock
    ├── doc
    │   ├── API field lists.xlsx
    │   ├── PatentsView API Design and Technical Notes.md
    │   ├── _page.html
    │   ├── _section.html
    │   ├── assignee.html
    │   ├── cpc_subsection.html
    │   ├── css
    │   │   └── custom.css
    │   ├── doc.html
    │   ├── doc.md
    │   ├── img
    │   │   └── logo.png
    │   ├── inventor.html
    │   ├── js
    │   │   └── svg-pan-zoom.min.js
    │   ├── location.html
    │   ├── make_doc.py
    │   ├── nber_subcat.html
    │   ├── patent.html
    │   ├── query_language.html
    │   ├── schema
    │   │   ├── README.md
    │   │   ├── fake_schema.sql
    │   │   └── schema.svg
    │   ├── temp
    │   │   ├── assignee.html
    │   │   ├── cpc_subsection.html
    │   │   ├── css
    │   │   │   └── custom.css
    │   │   ├── doc.html
    │   │   ├── field_lists
    │   │   │   ├── assignee.json
    │   │   │   ├── cpc_subsection.json
    │   │   │   ├── inventor.json
    │   │   │   ├── location.json
    │   │   │   ├── nber_subcat.json
    │   │   │   ├── patent.json
    │   │   │   └── uspc.json
    │   │   ├── img
    │   │   │   └── logo.png
    │   │   ├── inventor.html
    │   │   ├── js
    │   │   │   └── svg-pan-zoom.min.js
    │   │   ├── location.html
    │   │   ├── nber_subcat.html
    │   │   ├── patent.html
    │   │   ├── query_language.html
    │   │   └── uspc.html
    │   └── uspc.html
    ├── public_html
    │   └── index.php
    ├── resources
    │   └── logger-config.xml
    └── tests
    │   ├── ConfigTest.php
    │   ├── DatabaseQuery_Test.php
    │   ├── EntitySpecsTest.php
    │   ├── QueryParserTest.php
    │   ├── QueryParser_Test.php
    │   ├── RouteTest.php
    │   ├── convertDBResultsToAPIResponse_Test.php
    │   ├── convertDBResultsToNestedStructure_Test.php
    │   ├── executeQuery_Test.php
    │   ├── parseQuery_Test.php
    │   ├── queryDatabase_Test.php
    │   └── testspec
    │       ├── assignee_master_field_list.json
    │       ├── cpc_master_field_list.json
    │       ├── inventor_master_field_list.json
    │       ├── location_master_field_list.json
    │       ├── nber_master_field_list.json
    │       ├── patent_master_field_list.json
    │       └── uspc_master_field_list.json
├── swagger
└── user_contributions
    ├── README.md
    └── swagger
        ├── README.md
        └── patentsview.json


/.dockerignore:
--------------------------------------------------------------------------------
 1 | profiler/*
 2 | .ipynb_checkpoints/*
 3 | .ebextensions
 4 | .elasticbeanstalk
 5 | .ipynb_checkpoints
 6 | .platform
 7 | build_artifacts
 8 | user_contributions
 9 | **/.DS_Store
10 | logs


--------------------------------------------------------------------------------
/.ebignore:
--------------------------------------------------------------------------------
 1 | querymodule/public_html/web.config
 2 | .idea
 3 | *.log
 4 | archive
 5 | data
 6 | **/.DS_Store
 7 | experiments
 8 | copilot
 9 | querymodule/sessionmanager-bundle
10 | build_artifacts
11 | cache-db-disk
12 | docker-entrypoint-initdb.d
13 | _docker
14 | querymodule/sessionmanager-bundle


--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
 1 | querymodule/app/config.php
 2 | querymodule/public_html/web.config
 3 | .idea
 4 | *.log
 5 | app.ini
 6 | querymodule/vendor/
 7 | .htaccess
 8 | .vscode
 9 | profiler/
10 | querymodule/public_html/xhprof/
11 | experiments/
12 | **/.ipynb_checkpoints/
13 | build_artifacts/
14 | 
15 | # Elastic Beanstalk Files
16 | .elasticbeanstalk/*
17 | !.elasticbeanstalk/*.cfg.yml
18 | !.elasticbeanstalk/*.global.yml
19 | .ebextensions/*
20 | .elasticbeanstalk/*
21 | .platform/*
22 | 
23 | archive
24 | data
25 | **/.DS_Store
26 | experiments
27 | copilot
28 | querymodule/sessionmanager-bundle
29 | build_artifacts
30 | cache-db-disk
31 | docker-entrypoint-initdb.d


--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
 1 | Copyright (c) 2014, CSSIP-AIR
 2 | All rights reserved.
 3 | 
 4 | Redistribution and use in source and binary forms, with or without
 5 | modification, are permitted provided that the following conditions are met:
 6 | 
 7 | * Redistributions of source code must retain the above copyright notice, this
 8 |   list of conditions and the following disclaimer.
 9 | 
10 | * Redistributions in binary form must reproduce the above copyright notice,
11 |   this list of conditions and the following disclaimer in the documentation
12 |   and/or other materials provided with the distribution.
13 | 
14 | THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
15 | AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 | IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
17 | DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
18 | FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 | DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
20 | SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
21 | CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
22 | OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23 | OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24 | 
25 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # PatentsView-API
2 | 
3 | You can find instructions for setting up the server for hosting the API here: <https://github.com/CSSIP-AIR/PatentsView-API/wiki/API-Site-Setup-Instructions>
4 | 
5 | ## Header and footer script
6 | 
7 | Built from https://github.com/American-Institutes-for-Research/pv-header-footer


--------------------------------------------------------------------------------
/_config.yml:
--------------------------------------------------------------------------------
1 | theme: jekyll-theme-minimal


--------------------------------------------------------------------------------
/querymodule/DBScripts/PVSupport.sql:
--------------------------------------------------------------------------------
 1 | -- --------------------------------------------------------
 2 | -- Host:                         
 3 | -- Server version:               5.6.21-log - MySQL Community Server (GPL)
 4 | -- Server OS:                    Linux
 5 | -- HeidiSQL Version:             8.3.0.4694
 6 | -- --------------------------------------------------------
 7 | 
 8 | /*!40101 SET @OLD_CHARACTER_SET_CLIENT=@@CHARACTER_SET_CLIENT */;
 9 | /*!40101 SET NAMES utf8 */;
10 | /*!40014 SET @OLD_FOREIGN_KEY_CHECKS=@@FOREIGN_KEY_CHECKS, FOREIGN_KEY_CHECKS=0 */;
11 | /*!40101 SET @OLD_SQL_MODE=@@SQL_MODE, SQL_MODE='NO_AUTO_VALUE_ON_ZERO' */;
12 | 
13 | -- Dumping structure for table PVSupport.QueryDef
14 | CREATE TABLE IF NOT EXISTS `QueryDef` (
15 |   `QueryDefId` bigint(20) unsigned NOT NULL,
16 |   `QueryString` text NOT NULL,
17 |   `Created` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP,
18 |   PRIMARY KEY (`QueryDefId`)
19 | ) ENGINE=InnoDB DEFAULT CHARSET=utf8;
20 | 
21 | -- Data exporting was unselected.
22 | 
23 | 
24 | -- Dumping structure for table PVSupport.QueryResults
25 | CREATE TABLE IF NOT EXISTS `QueryResults` (
26 |   `QueryDefId` bigint(20) unsigned NOT NULL,
27 |   `Sequence` int(11) unsigned NOT NULL,
28 |   `EntityId` varchar(50) NOT NULL,
29 |   KEY `QueryDefId_Sequence` (`QueryDefId`,`Sequence`),
30 |   KEY `EntityId` (`EntityId`)
31 | ) ENGINE=InnoDB DEFAULT CHARSET=utf8;
32 | 
33 | -- Data exporting was unselected.
34 | /*!40101 SET SQL_MODE=IFNULL(@OLD_SQL_MODE, '') */;
35 | /*!40014 SET FOREIGN_KEY_CHECKS=IF(@OLD_FOREIGN_KEY_CHECKS IS NULL, 1, @OLD_FOREIGN_KEY_CHECKS) */;
36 | /*!40101 SET CHARACTER_SET_CLIENT=@OLD_CHARACTER_SET_CLIENT */;
37 | 


--------------------------------------------------------------------------------
/querymodule/app/APILoggingConfigurator.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Created by PhpStorm.
 4 |  * User: smadhavan
 5 |  * Date: 8/17/18
 6 |  * Time: 6:30 PM
 7 |  */
 8 | 
 9 | class APILoggingConfigurator implements LoggerConfigurator
10 | {
11 | 
12 |     /**
13 |      * Configures log4php based on the given configuration.
14 |      *
15 |      * All configurators implementations must implement this interface.
16 |      *
17 |      * @param LoggerHierarchy $hierarchy The hierarchy on which to perform
18 |      *        the configuration.
19 |      * @param mixed $input Either path to the config file or the
20 |      *        configuration as an array.
21 |      */
22 |     public function configure(LoggerHierarchy $hierarchy, $input = null)
23 |     {
24 |         $appFile = new LoggerAppenderFile('foo');
25 |         $appFile->setFile('D:/Temp/log.txt');
26 |         $appFile->setAppend(true);
27 |         $appFile->setThreshold('all');
28 |         $appFile->activateOptions();
29 | 
30 |         // Use a different layout for the next appender
31 |         $layout = new LoggerLayoutPattern();
32 |         $layout->setConversionPattern("%date %logger %msg%newline");
33 |         $layout->activateOptions();
34 | 
35 |         // Create an appender which echoes log events, using a custom layout
36 |         // and with the threshold set to INFO
37 |         $appEcho = new LoggerAppenderEcho('bar');
38 |         $appEcho->setLayout($layout);
39 |         $appEcho->setThreshold('info');
40 |         $appEcho->activateOptions();
41 | 
42 |         // Add both appenders to the root logger
43 |         $root = $hierarchy->getRootLogger();
44 |         $root->addAppender($appFile);
45 |         $root->addAppender($appEcho);
46 |     }
47 | }


--------------------------------------------------------------------------------
/querymodule/app/AddEmailDatabase.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | require_once dirname(__FILE__) . '/Config.php';
  3 | require_once dirname(__FILE__) . '/ErrorHandler.php';
  4 | 
  5 | 
  6 | class AddEmailDatabase
  7 | {
  8 |     private $db = null;
  9 |     private $errorHandler = null;
 10 | 
 11 |     private $supportDatabase = "";
 12 | 
 13 |     public function addEmail($email)
 14 |     {
 15 | 	global $config;
 16 |         $dbSettings = $config->getDbSettings();
 17 |         $this->supportDatabase = $dbSettings['supportDatabase'];	
 18 | 
 19 |         $memUsed = memory_get_usage();
 20 |         $this->errorHandler = ErrorHandler::getHandler();
 21 | 
 22 | 	// Get the QueryDefId for this where clause
 23 |         $stringToHash = $email;
 24 |         $whereHash = crc32($stringToHash);   // Using crc32 rather than md5 since we only have 32-bits to work with.
 25 |         $queryDefId = sprintf('%u', $whereHash);
 26 | 	
 27 | 	
 28 | 	
 29 |         $county = 0;
 30 | 		$maxTries = 3;
 31 | 		do {
 32 | 			try {
 33 | 			// If the query results for this where clause don't already exist, then we need to run the
 34 |         		// query and cache the primary entity IDs.
 35 |         		$results = $this->runQuery('EmailDefId,Email', $this->supportDatabase . '.EmailDef', "EmailDefID=$queryDefId", null);
 36 |         		//TODO Need to handle a hash collision
 37 |         		if (count($results) == 0) {
 38 |             		// Add an entry for the query
 39 |             		
 40 |                 		$this->startTransaction();
 41 |                 		$insertStatement = $this->supportDatabase . '.EmailDef (EmailDefId, Email) VALUES (:queryDefId, :whereClause)';
 42 | 				$this->runInsert($insertStatement, array(':queryDefId' => $queryDefId, ':whereClause' => $stringToHash));
 43 | 				
 44 |                 		$this->commitTransaction();
 45 |                 		break;
 46 |             		}
 47 | 			}
 48 | 			catch (Exception $e) {
 49 | 				$this->rollbackTransaction();
 50 | 				$county++;
 51 | 				if ($county==$maxTries) {
 52 | 					$this->errorHandler->sendError(500, "Insert select execution failed.", $e);
 53 |             				throw new $e;
 54 | 					break; }
 55 | 				usleep(500000);
 56 | 				continue;	
 57 | 			}
 58 | 		break;
 59 | 		
 60 | 	   } while($county < $maxTries);
 61 |     }
 62 | 
 63 |        
 64 |     private function runQuery($select, $from, $where, $order)
 65 |     {
 66 |         $this->connectToDB();
 67 | 
 68 |         if (strlen($where) > 0) $where = "WHERE $where ";
 69 |         if (strlen($order) > 0) $order = "ORDER BY $order";
 70 |         $sqlQuery = "SELECT $select FROM $from $where $order";
 71 | 	$this->errorHandler->getLogger()->debug($sqlQuery);
 72 | 	
 73 | 	try {
 74 |             $st = $this->db->query("$sqlQuery", PDO::FETCH_ASSOC);
 75 |             $results = $st->fetchAll();
 76 |             $st->closeCursor();
 77 |         }
 78 |         catch (Exception $e) {
 79 |             $this->errorHandler->sendError(500, "Query execution failed.", $e . "\n" . $sqlQuery);
 80 |             throw new $e;
 81 |         }
 82 | 
 83 |         return $results;
 84 |     }
 85 | 
 86 | 
 87 |     private function runInsert($insert, $params)
 88 |     {
 89 |         $this->connectToDB();
 90 | 
 91 |         $sqlStatement = "INSERT INTO $insert";
 92 |         $this->errorHandler->getLogger()->debug($sqlStatement);
 93 |         $this->errorHandler->getLogger()->debug($params);
 94 | 	
 95 | 	$counto = 0;
 96 | 	$maxTriesy = 3;
 97 | 	do {
 98 |     	    try {        
 99 |     		$st = $this->db->prepare($sqlStatement);
100 |             	$results = $st->execute($params);
101 |             	$st->closeCursor();
102 | 		break;
103 |         	}
104 |             catch (Exception $e) {
105 |             	if ($counto==$maxTriesy) {
106 | 			$this->errorHandler->sendError(500, "Insert execution failed.", $e . "\n" . $sqlStatement);		
107 | 			throw new $e;
108 | 			break;}
109 | 	    	usleep(1000000);
110 | 	    	continue;
111 |         	}
112 | 	break;
113 | 	     } while($counto<$maxTriesy);
114 | 
115 |         return $results;
116 |     }
117 | 
118 |     private function buildSelectString()
119 |     {
120 |         $selectString = '';
121 | 
122 |         foreach ($this->selectFieldSpecs as $apiField => $fieldInfo) {
123 |             if ($selectString != '')
124 |                 $selectString .= ', ';
125 |             $selectString .= getDBField($this->fieldSpecs, $apiField) . " as $apiField";
126 |         }
127 | 
128 |         return $selectString;
129 |     }
130 | 
131 | 
132 |     private function buildSelectStringForEntityReturnApiField($entitySpec)
133 |     {
134 | 	$selectString = Array();
135 | 	foreach ($this->selectFieldSpecs as $apiField => $fieldInfo) {
136 | 	    if ($fieldInfo['entity_name'] == $entitySpec['entity_name']) {
137 | 		$selectString[] = $apiField;
138 |             }
139 |         }
140 |         return $selectString;
141 |     }
142 | 
143 | 
144 |     private function buildSortString($sortParam)
145 |     {
146 |         $orderString = '';
147 | 	if ($sortParam != null) {
148 | 	    foreach ($sortParam as $sortField) {
149 | 		foreach($sortField as $apiField=>$direction) {
150 |                 try {
151 |                     $fieldSpec = $this->fieldSpecs[$apiField];
152 |                 }
153 |                 catch (ErrorException $e) {
154 |                     ErrorHandler::getHandler()->sendError(400, "Invalid field for sorting: $apiField");
155 |                     throw $e;
156 |                 }
157 |                 if (strtolower($fieldSpec['sort']) == 'y') {
158 |                     if (($direction != 'asc') and ($direction != 'desc')) {
159 |                         ErrorHandler::getHandler()->sendError(400, "Not a valid direction for sorting: $direction");
160 |                         throw new ErrorException("Not a valid direction for sorting: $direction");
161 |                     }
162 |                     else {
163 |                         if ($orderString != '')
164 |                             $orderString .= ', ';
165 |                         $orderString .= getDBField($this->fieldSpecs, $apiField) . ' ' . $direction;
166 |                         $this->sortFieldsUsed[] = $apiField;
167 |                     }
168 |                 } elseif (strtolower($fieldSpec['sort']) == 'suppl') {
169 | 		    if (($direction != 'asc') and ($direction != 'desc')) {
170 |                         ErrorHandler::getHandler()->sendError(400, "Not a valid direction for sorting: $direction");
171 |                         throw new ErrorException("Not a valid direction for sorting: $direction");
172 |                     }
173 |                     else {
174 |                         if ($orderString != '')
175 |                             $orderString .= ', ';
176 |                         $orderString .= getDBField($this->fieldSpecs, $apiField) . ' ' . $direction;
177 | 			$this->sortFieldsUsed[] = $apiField;
178 | 			if (!$this->sort_by_subentity_counts || ($this->sort_by_subentity_counts && getDBField($this->fieldSpecs, $apiField) !== getDBField($this->fieldSpecs, $this->sort_by_subentity_counts))) {
179 | 
180 | 				$secEntityField = $fieldSpec['entity_name'];
181 | 				$secEntityField .= "s";
182 | 
183 | 				if (array_key_exists($secEntityField,$this->sortFieldsUsedSec)) {
184 | 					array_push($this->sortFieldsUsedSec[$secEntityField],getDBField($this->fieldSpecs, $apiField) . ' ' . $direction);
185 | 				} else {
186 | 					$this->sortFieldsUsedSec[$secEntityField] = array(getDBField($this->fieldSpecs, $apiField) . ' ' . $direction);
187 | 				}
188 | 			}
189 |                     } 
190 |                 } else {
191 |                     $msg = "Not a valid field for sorting: $apiField";
192 |                     ErrorHandler::getHandler()->sendError(400, $msg);
193 |                     throw new ErrorException($msg);
194 |                 }}
195 |             }
196 |         }
197 | 
198 |         if ($orderString != '')
199 |             $orderString .= ', ';
200 |         $orderString .= getDBField($this->fieldSpecs, $this->entityGroupVars[0]['keyId']);
201 | 	return $orderString;
202 |     }
203 | 
204 |     private function buildFrom(array $whereFieldsUsed, array $selectFieldSpecs, array $sortFields)
205 |     {
206 |         // Smerge all the fields into one array
207 |         $allFieldsUsed = array_merge($whereFieldsUsed, array_keys($selectFieldSpecs), $sortFields);
208 |         $allFieldsUsed = array_unique($allFieldsUsed);
209 |         $fromString = '';
210 |         $joins = array();
211 | 
212 |         // We need to go through the entities in order so the joins are done in the same order as they appear
213 |         // in the entity specs.
214 |         foreach ($this->entityGroupVars as $group)
215 |             foreach ($allFieldsUsed as $apiField)
216 |                 if ($group['entity_name'] == $this->fieldSpecs[$apiField]['entity_name'])
217 |                     if (!in_array($group['join'], $joins))
218 |                         $joins[] = $group['join'];
219 | 
220 |         foreach ($joins as $join) {
221 |             $fromString .= ' ' . $join . ' ';
222 |         }
223 | 
224 |         return $fromString;
225 |     }
226 | 
227 |     private function setupGroupVars()
228 |     {
229 | 
230 |         $this->entityGroupVars = $this->entitySpecs;
231 |         foreach ($this->entityGroupVars as &$group) {
232 |             $name = $group['entity_name'];
233 |             $group['hasId'] = "alreadyHas{$name}Id";
234 |             $group['hasFields'] = "has{$name}Fields";
235 |         }
236 |         unset($group);
237 |    }
238 | 
239 |     private function connectToDB()
240 |     {
241 |         global $config;
242 |         if ($this->db === null) {
243 |             $dbSettings = $config->getDbSettings();
244 |             try {
245 |                 $this->db = new PDO("mysql:host=$dbSettings[host];dbname=$dbSettings[database];charset=utf8", $dbSettings['user'], $dbSettings['password']);
246 |                 $this->db->setAttribute(PDO::ATTR_ERRMODE, PDO::ERRMODE_EXCEPTION);
247 |             } catch (PDOException $e) {
248 |                 $this->errorHandler->sendError(500, "Failed to connect to database: $dbSettings[database].", $e);
249 |                 throw new $e;
250 |             }
251 |         }
252 |     }
253 | 
254 |     private function startTransaction()
255 |     {
256 |         $this->db->beginTransaction();
257 |     }
258 | 
259 |     private function commitTransaction()
260 |     {
261 |         $this->db->commit();
262 |     }
263 | 
264 |     private function rollbackTransaction() {
265 |         $this->db->rollback();
266 |     }
267 | 
268 |     
269 | }


--------------------------------------------------------------------------------
/querymodule/app/ErrorHandler.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | use Monolog\Level;
 4 | use Monolog\Logger;
 5 | use Monolog\Handler\StreamHandler;
 6 | 
 7 | class ErrorHandler
 8 | {
 9 | 
10 |     // Pattern for this singleton from here: http://www.phptherightway.com/pages/Design-Patterns.html
11 |     public static function getHandler()
12 |     {
13 |         static $instance = null;
14 |         if ($instance === null) {
15 |             $instance = new static();
16 |         }
17 |         return $instance;
18 |     }
19 | 
20 |     /**
21 |      * Protected constructor to prevent creating a new instance of the
22 |      * *Singleton* via the `new` operator from outside of this class.
23 |      */
24 |     protected function __construct()
25 |     {
26 |     }
27 | 
28 |     /**
29 |      * Private clone method to prevent cloning of the instance of the
30 |      * *Singleton* instance.
31 |      *
32 |      * @return void
33 |      */
34 |     private function __clone()
35 |     {
36 |     }
37 | 
38 |     /**
39 |      * Private unserialize method to prevent unserializing of the *Singleton*
40 |      * instance.
41 |      *
42 |      * @return void
43 |      */
44 |     private function __wakeup()
45 |     {
46 |     }
47 | 
48 |     public function sendError($status, $friendlyMessage,$config, $details = null)
49 |     {
50 |         global $app;
51 |         if ($details === null) $details = $friendlyMessage;
52 |         $this->getLogger($config)->error($details);
53 |         if ($app !== null) {
54 |             $app->response->header('X-Status-Reason', $friendlyMessage);
55 |             $app->halt($status);
56 |         }
57 |     }
58 | 
59 |     public function getLogger($config)
60 |     {
61 |         static $logger = null;
62 |         if ($logger === null) {
63 |             // create a log channel
64 |             $logger = new Logger('API');
65 |             $log_path = $config->getLogPath();
66 |             $rHandler = new \Monolog\Handler\RotatingFileHandler($log_path . 'api.log', 14, Logger::INFO);
67 | 
68 | //            $cHandler = new \Monolog\Handler\StreamHandler($log_path . 'api.log', 14, Logger::DEBUG);
69 | 
70 |             $logger->pushHandler($rHandler);
71 |         }
72 |         return $logger;
73 |     }
74 | } 


--------------------------------------------------------------------------------
/querymodule/app/Exceptions/APIError.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Created by PhpStorm.
 4 |  * User: smadhavan
 5 |  * Date: 9/20/18
 6 |  * Time: 3:44 PM
 7 |  */
 8 | 
 9 | namespace Exceptions;
10 | require_once dirname(__FILE__) . '/../ErrorHandler.php';
11 | 
12 | use Exceptions\APIException;
13 | use Psr\Http\Message\ResponseInterface as Response;
14 | use Psr\Http\Message\ServerRequestInterface as Request;
15 | use UnexpectedValueException;
16 | 
17 | final class APIError extends \Exception
18 | {
19 |     public function __invoke($request, $response, $exception)
20 |     {
21 |         global $config;
22 |         $status = $exception->getCode() ?: 500;
23 |         $logger = \ErrorHandler::getHandler()->getLogger($config);
24 |         $ip = $request->getServerParam('REMOTE_ADDR');
25 | //        try {
26 | //            $customCode = $exception->getCustomCode();
27 | //        } catch (UnexpectedValueException $e) {
28 | //            $customCode = 'UNK';
29 | //        }
30 | 
31 |         $query = $request->getUri();
32 |         $logger->error("$status\t$ip\t$query");
33 |         return $response->withHeader("X-Status-Reason", $exception->getMessage())->withJson(array("status" => "error", "payload" => array("error" => $exception->getMessage(), "code" => "")), $status);
34 |     }
35 | 
36 | 
37 | }
38 | 


--------------------------------------------------------------------------------
/querymodule/app/Exceptions/APIException.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Created by PhpStorm.
 4 |  * User: smadhavan
 5 |  * Date: 9/20/18
 6 |  * Time: 4:08 PM
 7 |  */
 8 | 
 9 | namespace Exceptions;
10 | 
11 | 
12 | use Throwable;
13 | 
14 | abstract class APIException extends \Exception
15 | {
16 |     protected $code_mapping;
17 |     public function __construct($message = "", $code = "", Throwable $previous = null)
18 |     {
19 |         $this->custom_code = $code;
20 |         parent::__construct($message, $this->code_mapping[$code], $previous);
21 |     }
22 |     public function getCustomCode()
23 |     {
24 |         return $this->custom_code;
25 |     }
26 | }


--------------------------------------------------------------------------------
/querymodule/app/Exceptions/ParsingException.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Created by PhpStorm.
 4 |  * User: smadhavan
 5 |  * Date: 9/20/18
 6 |  * Time: 4:46 PM
 7 |  */
 8 | 
 9 | namespace Exceptions;
10 | 
11 | require_once(dirname(__FILE__) . "/APIException.php");
12 | 
13 | class ParsingException extends APIException
14 | {
15 |     protected $message = array("PINV1" => "Invalid integer value provided: %s",
16 |         "PINV2" => "Invalid float value provided: %s",
17 |         "PINV3" => "Invalid date provided: %s",
18 |         "PINV4" => "Invalid field type %s found for  %s",
19 |         "PINV5" => "Not a valid field for querying: %s",
20 |         "PINV6" => "Invalid field type %s or operator %s found for %s.",
21 |         "PINV7" => "The operation %s is not valid on %s.",
22 |         "PINV8" => "Invalid field specified: %s ");
23 | 
24 | 
25 |     public function __construct($code = "", array $custom_message = array(), Throwable $previous = null)
26 |     {
27 |         $this->code_mapping=array("PINV1" => 400, "PINV2" => 400, "PINV3" => 400, "PINV4" => 400, "PINV5" => 400, "PINV6" => 400, "PINV7" => 400, "PINV8" => 400);
28 | 
29 |         parent::__construct(vsprintf($this->message[$code],  $custom_message), $code, $previous);
30 |     }
31 | 
32 | }


--------------------------------------------------------------------------------
/querymodule/app/Exceptions/QueryException.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Created by PhpStorm.
 4 |  * User: smadhavan
 5 |  * Date: 9/21/18
 6 |  * Time: 4:53 PM
 7 |  */
 8 | 
 9 | namespace Exceptions;
10 | 
11 | require_once(dirname(__FILE__) . "/APIException.php");
12 | 
13 | class QueryException extends APIException
14 | {
15 |     protected $message = array(
16 |         "QR1" => "Per_page must be a positive number not to exceed: %d",
17 |         "QR2" => "Sorting field %s is not in the output field list.",
18 |         "QR3" => "Invalid field for sorting: %s",
19 |         "QR4" => "Not a valid direction for sorting: %s",
20 |         "QDI1" => "Query Internal Error",
21 |         "QDI2" => "Query Internal Error",
22 |         "QDS1" => "Query Internal Error",
23 |         "QDIS1" => "Query Internal Error",
24 |         "QDC1" => "Query Internal Error",
25 |         "QDIS2" => "Query Internal Error",
26 |         "QDIS3" => "Query Internal Error");
27 | 
28 | 
29 |     public function __construct($code = "", array $custom_message = array(), Throwable $previous = null)
30 |     {
31 |         global $config;
32 |         $this->code_mapping = array("QR1" => 400, "QR2" => 400, "QR3" => 400, "QR4" => 400, "QDI1" => 500, "QDI2" => 500, "QDS1" => 500, "QDIS1" => 500, "QDC1" => 500, "QDIS2" => 500, "QDIS3" => 500);
33 |         $message = vsprintf($this->message[$code], $custom_message);
34 |         \ErrorHandler::getHandler()->getLogger($config)->info($message);
35 |         parent::__construct($message, $code, $previous);
36 |     }
37 | }


--------------------------------------------------------------------------------
/querymodule/app/Exceptions/RequestException.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Created by PhpStorm.
 4 |  * User: smadhavan
 5 |  * Date: 9/20/18
 6 |  * Time: 1:55 PM
 7 |  */
 8 | 
 9 | namespace Exceptions;
10 | 
11 | 
12 | require_once(dirname(__FILE__) . "/APIException.php");
13 | 
14 | class RequestException extends APIException
15 | {
16 |     protected $message = array("RQ1" => "'q' param is missing", "RQ2" => "'q' param is not valid json", "RQ3" => "'q' parameter: should only have one json object in the top-level dictionary.", "RF2" => "'f' param is not valid json", "RS2" => "'s' parameter: is not valid json", "RO2" => "'o' param is not valid json", "RFO4" => "Invalid option for 'format' parameter: use either 'json' or 'xml'.", "POST1" => "Body does not contain valid JSON: ");
17 | 
18 |     public function __construct($code = "", array $custom_message = array(), Throwable $previous = null)
19 |     {
20 |         $this->code_mapping = array("RQ1" => 400, "RQ2" => 400, "RQ3" => 400, "RF2" => 400, "RS2" => 400, "RO2" => 400, "RFO4" => 400);
21 |         parent::__construct(vsprintf($this->message[$code], $custom_message), $code, $previous);
22 |     }
23 | 
24 | 
25 | }


--------------------------------------------------------------------------------
/querymodule/app/convertDBResultsToNestedStructure.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | require_once dirname(__FILE__) . '/entitySpecs.php';
  3 | 
  4 | 
  5 | /**
  6 |  * This function will convert an array of rows of columns of data into an array of primary entities, with each element
  7 |  * containing the primary entity fields and arrays of secondary entities (as needed).
  8 |  * @param array $dbResults
  9 |  * @param array $selectFieldSpecs
 10 |  * @return array
 11 |  */
 12 | function convertDBResultsToNestedStructure(array $entitySpecs, array $dbResults = null, array $selectFieldSpecs = null)
 13 | {
 14 |     // This function relies heavily on the concept of grouped items. The results from the API is expected to be an array of
 15 |     // primary entities, and within each primary entity there may be an array of entities (inventors, assignees, classes, etc.).
 16 | 
 17 |     // This will be used to created dynamic variables. By using dynamic variables we are able to save well over
 18 |     // a hundred lines of code, but some readability is lost. For debugging in PHPStorm, which doesn't show
 19 |     // dynamic variables in its debugger window, you need to create them as watch variables to see the values.
 20 |     // For example, ${$group['priorId']} gets resolved to $priorinventorId; ${$group['group_name']} to $inventors
 21 | 
 22 | 
 23 |     $groupVars = $entitySpecs;
 24 |     foreach ($groupVars as &$group) {
 25 |         $name = $group['entity_name'];
 26 |         $group['thisId'] = "this{$name}Id";
 27 |         $group['has'] = "has{$name}";
 28 |         $group['byPrimaryEntityId'] = "{$name}ByPrimaryEntityId";
 29 |     }
 30 |     unset($group); // Need to do this since it was used by reference in the above foreach
 31 | 
 32 |     if (!$dbResults[$groupVars[0]['group_name']]) {
 33 |         return array($groupVars[0]['group_name'] => null, 'count' => 0);
 34 |     }
 35 | 
 36 |     $primaryEntityGroup = $groupVars[0];
 37 |     // Start with totally empty primary entity structures
 38 |     ${$primaryEntityGroup['thisId']} = null;
 39 |     ${$primaryEntityGroup['group_name']} = array();    // our top-level structure will be a list of primary entities
 40 |     ${$primaryEntityGroup['entity_name']} = array();     // dictionary of primary entity field/value pairs
 41 | 
 42 |     foreach (array_slice($groupVars, 1) as $group) {
 43 |         ${$group['thisId']} = null;     // the id of an entity in this row
 44 |         ${$group['entity_name']} = array();    // dictionary of an entities field/value pairs
 45 |         ${$group['group_name']} = array();   // array of entities
 46 |         ${$group['byPrimaryEntityId']} = array();
 47 |         // Check once to see if there are any fields for an entity
 48 |         ${$group['has']} = isset($dbResults[$group['group_name']]);
 49 |     }
 50 | 
 51 |     // Slice the groups into associative arrays with the primary entity ID as the key. We do this so we don't
 52 |     // have to iterate through every group row for every primary entity instance.
 53 |     foreach (array_slice($groupVars, 1) as $group)
 54 |         if (isset($dbResults[$group['group_name']]))
 55 |             foreach ($dbResults[$group['group_name']] as $groupRow) {
 56 |                 if (!isset(${$group['byPrimaryEntityId']}[$groupRow[$primaryEntityGroup['keyId']]]))
 57 |                     ${$group['byPrimaryEntityId']}[$groupRow[$primaryEntityGroup['keyId']]] = array();
 58 |                 ${$group['byPrimaryEntityId']}[$groupRow[$primaryEntityGroup['keyId']]][] = $groupRow;
 59 |             }
 60 | 
 61 | 
 62 |     // Iterate through the primary entity DB results one row at a time. It might be possible to slice or subset the rows by
 63 |     // primary entity ID, but iterating straight through the list is probably most efficient
 64 | 
 65 |     foreach ($dbResults[$primaryEntityGroup['group_name']] as $row) {
 66 |         ${$primaryEntityGroup['thisId']} = $row[$primaryEntityGroup['keyId']];
 67 |         ${$primaryEntityGroup['entity_name']} = array();
 68 |         foreach ($row as $apiField => $val) {
 69 |             // Check to make sure the field was in the original field list, and not a field we added
 70 | 
 71 |             if (isset($selectFieldSpecs[$apiField])) {
 72 | 
 73 |                 ${$primaryEntityGroup['entity_name']}[$apiField] = $val;    // add the field/value to the primary entity
 74 |             }
 75 |         }
 76 |         foreach (array_slice($groupVars, 1) as $group) {
 77 | 
 78 |             if (isset($dbResults[$group['group_name']])) {
 79 |                 ${$group['group_name']} = array();
 80 |                 if (array_key_exists(${$primaryEntityGroup['thisId']}, ${$group['byPrimaryEntityId']})) {
 81 |                     foreach (${$group['byPrimaryEntityId']}[${$primaryEntityGroup['thisId']}] as $groupRow) {
 82 |                         ${$group['entity_name']} = $groupRow;
 83 |                         unset(${$group['entity_name']}[$primaryEntityGroup['keyId']]);
 84 |                         // Check to make sure the field was in the original field list, and not a field we added
 85 | //                        foreach ($groupRow as $apiField => $val){
 86 | ////                            file_put_contents('php://stderr', print_r($selectFieldSpecs, TRUE));
 87 | ////                            file_put_contents('php://stderr', print_r("\n", TRUE));
 88 | ////                            file_put_contents('php://stderr', print_r($apiField, TRUE));
 89 | ////                            file_put_contents('php://stderr', print_r("\n", TRUE));
 90 | ////                            file_put_contents('php://stderr', print_r($group['entity_name'], TRUE));
 91 | ////                            file_put_contents('php://stderr', print_r("\n", TRUE));
 92 | //
 93 | //                            if (!isset($selectFieldSpecs[$apiField]))
 94 | //                                unset(${$group['entity_name']}[$apiField]);
 95 | //                        }
 96 |                         ${$group['group_name']}[] = ${$group['entity_name']};
 97 |                     }
 98 |                     ${$primaryEntityGroup['entity_name']}[$group['group_name']] = ${$group['group_name']};
 99 |                 }
100 |             }
101 |         }
102 |         ${$primaryEntityGroup['group_name']}[] = ${$primaryEntityGroup['entity_name']};
103 |     }
104 | 
105 | 
106 |     return array($primaryEntityGroup['group_name'] => ${$primaryEntityGroup['group_name']}, 'count' => count(${$primaryEntityGroup['group_name']}));
107 | }
108 | 


--------------------------------------------------------------------------------
/querymodule/app/entitySpecs.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | require_once dirname(__FILE__) . '/ErrorHandler.php';
 3 | 
 4 | function getDBField(array $fieldSpecs, $apiFieldName, $columnFor = "column_name")
 5 | {
 6 |     global $config;
 7 |     if (!array_key_exists($apiFieldName, $fieldSpecs)) {
 8 |         ErrorHandler::getHandler()->sendError(400, "Field name is invalid: $apiFieldName.", $config,
 9 |             "Field name not in FIELD_SPECS: $apiFieldName.");
10 |     }
11 |     return $fieldSpecs[$apiFieldName][$columnFor];
12 | }
13 | 
14 | /*
15 |  * ENTITY_SPECS: defines the entities we are dealing with. The first one is the primary entity; the others are
16 |  *              subentities.
17 |  * entity_name: name for this entity type. Used internal for an individual entity. Used externally as the name for
18 |  *              individual units of this entity
19 |  * group_name:  plural name for the group. Used internal for aggregating into groups and for external output.
20 |  * keyId:       The field in the FIELD_SPECS that is a unique identifier. Could be blank for those entity types
21 |  *              that are not really considered individual entities, but are more of a list of grouped attributes
22 |  * join:        The SQL join statement that will bring in the data for this entity type when connected with the
23 |  *              primary entity's JOIN statement. Note: these must be able to be used in aggregate with all the
24 |  *              other joins in the ENTITY_SPECS, so any duplicate joins to the same table must use a unique
25 |  *              alias for that table.
26 |  * default_fields:  Only needed for the primary entity. Lists the fields that will be included in the results
27 |  *              if API call does not include an explicit list of fields to include.
28 | */
29 | $patent_entity_json = file_get_contents(dirname(__FILE__) . '/specs/patent-entity-specs.json');
30 | $PATENT_ENTITY_SPECS = json_decode($patent_entity_json, true);
31 | $patent_field_json = file_get_contents(dirname(__FILE__) . '/specs/patent-field-specs.json');
32 | $PATENT_FIELD_SPECS = json_decode($patent_field_json, true);
33 | 
34 | $inventor_entity_json = file_get_contents(dirname(__FILE__) . '/specs/inventor-entity-specs.json');
35 | $INVENTOR_ENTITY_SPECS = json_decode($inventor_entity_json, true);
36 | $inventor_field_json = file_get_contents(dirname(__FILE__) . '/specs/inventor-field-specs.json');
37 | $INVENTOR_FIELD_SPECS = json_decode($inventor_field_json, true);
38 | 
39 | $assignee_entity_json = file_get_contents(dirname(__FILE__) . '/specs/assignee-entity-specs.json');
40 | $ASSIGNEE_ENTITY_SPECS = json_decode($assignee_entity_json, true);
41 | $assignee_field_json = file_get_contents(dirname(__FILE__) . '/specs/assignee-field-specs.json');
42 | $ASSIGNEE_FIELD_SPECS = json_decode($assignee_field_json, true);
43 | 
44 | $cpcgroup_entity_json = file_get_contents(dirname(__FILE__) . '/specs/cpc-group-entity-specs.json');
45 | $CPC_GROUP_ENTITY_SPECS = json_decode($cpcgroup_entity_json, true);
46 | $cpcgroup_field_json = file_get_contents(dirname(__FILE__) . '/specs/cpc-group-field-specs.json');
47 | $CPC_GROUP_FIELD_SPECS = json_decode($cpcgroup_field_json, true);
48 | 
49 | 
50 | $cpc_entity_json = file_get_contents(dirname(__FILE__) . '/specs/cpc-entity-specs.json');
51 | $CPC_ENTITY_SPECS = json_decode($cpc_entity_json, true);
52 | $cpc_field_json = file_get_contents(dirname(__FILE__) . '/specs/cpc-field-specs.json');
53 | $CPC_FIELD_SPECS = json_decode($cpc_field_json, true);
54 | 
55 | 
56 | $uspc_entity_json = file_get_contents(dirname(__FILE__) . '/specs/uspc-entity-specs.json');
57 | $USPC_ENTITY_SPECS = json_decode($uspc_entity_json, true);
58 | $uspc_field_json = file_get_contents(dirname(__FILE__) . '/specs/uspc-field-specs.json');
59 | $USPC_FIELD_SPECS = json_decode($uspc_field_json, true);
60 | 
61 | 
62 | $nber_entity_json = file_get_contents(dirname(__FILE__) . '/specs/nber-entity-specs.json');
63 | $NBER_ENTITY_SPECS = json_decode($nber_entity_json, true);
64 | $nber_field_json = file_get_contents(dirname(__FILE__) . '/specs/nber-field-specs.json');
65 | $NBER_FIELD_SPECS = json_decode($nber_field_json, true);
66 | 
67 | 
68 | $location_entity_json = file_get_contents(dirname(__FILE__) . '/specs/location-entity-specs.json');
69 | $LOCATION_ENTITY_SPECS = json_decode($location_entity_json, true);
70 | $location_field_json = file_get_contents(dirname(__FILE__) . '/specs/location-field-specs.json');
71 | $LOCATION_FIELD_SPECS = json_decode($location_field_json, true);
72 | 


--------------------------------------------------------------------------------
/querymodule/app/executeQuery.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | require_once dirname(__FILE__) . '/QueryParser.php';
 3 | require_once dirname(__FILE__) . '/DatabaseQuery.php';
 4 | require_once dirname(__FILE__) . '/convertDBResultsToNestedStructure.php';
 5 | 
 6 | function executeQuery(array $entitySpecs, array $fieldSpecs, array $queryParam = null, array $fieldsParam = null, array $sortParam = null, array $optionsParam = null)
 7 | {
 8 |     $qp = new QueryParser();
 9 | 
10 |     $entitySpecificWhereClauses = array();
11 | 
12 |     // Get each subentity-specific "where" clause. This will be used when getting the results from the DB and needing
13 |     // to limit the results based on the "matched_subentities_only" flag.
14 |     foreach ($entitySpecs as $entity) {
15 |         $entityName = $entity['entity_name'];
16 |         $entitySpecificWhereClauses[$entityName] = $qp->parse($fieldSpecs, $queryParam, $entityName);
17 |     }
18 | 
19 |     // Build the where clause to determine the primary entities for the results
20 |     $whereClause = $qp->parse($fieldSpecs, $queryParam, 'all');
21 | 
22 |     // If the caller did not explicitly list fields to be returned, get them from the other parameters.
23 |     # if (!$fieldsParam) $fieldsParam = $qp->getFieldsUsed();
24 |     // Changed so that if the caller did not explicitly list fields to be returned, we will use a pre-defined set
25 |     // for the primary entity.
26 |     if (!$fieldsParam) $fieldsParam = $entitySpecs[0]['default_fields'];
27 | 
28 |     // Get the FieldSpecs for the list of fields to be returned.
29 |     $selectFieldSpecs = parseFieldList($fieldSpecs, $fieldsParam);
30 | 
31 |     $dbQuery = new DatabaseQuery();
32 | 
33 |     // Run the query against the DB
34 |     $dbResults = $dbQuery->queryDatabase($entitySpecs, $fieldSpecs, $whereClause, $qp->getFieldsUsed(),
35 |         $entitySpecificWhereClauses, $qp->getOnlyAndsWereUsed(), $selectFieldSpecs, $sortParam, $optionsParam);
36 |     $count_results = array();
37 |     foreach ($dbQuery->getTotalCounts() as $entityName => $count)
38 |         $count_results['total_' . $entityName . '_count'] = $count;
39 |     unset($dbQuery);
40 | //    file_put_contents('php://stderr', print_r($dbResults, TRUE));
41 | //    file_put_contents('php://stderr', print_r("\n", TRUE));
42 |     // Convert the DB result structures to PHO structures. The DB results will be in multiple tables, and the
43 |     // PHP structures will be nested (only one-level) PHP arrays.
44 |     $results = convertDBResultsToNestedStructure($entitySpecs, $dbResults, $selectFieldSpecs);
45 | 
46 |     foreach ($count_results as $entityName => $count)
47 |         $results[$entityName] = $count;
48 |     return $results;
49 | }


--------------------------------------------------------------------------------
/querymodule/app/logger_config.xml:
--------------------------------------------------------------------------------
 1 | <configuration xmlns="http://logging.apache.org/log4php/">
 2 |     <appender name="myAppender" class="LoggerAppenderFile">
 3 |         <layout class="LoggerLayoutPattern">
 4 |             <param name="conversionPattern" value="%date %-5level:: %message%newline" />
 5 |         </layout>
 6 |         <param name="file" value="/tmp/myLog.log" />
 7 |     </appender>
 8 |     <root>
 9 |         <level value="WARN" />
10 |         <appender_ref ref="myAppender" />
11 |     </root>
12 | </configuration>


--------------------------------------------------------------------------------
/querymodule/app/routes/routeUtilites.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | /**
  3 |  * Created by PhpStorm.
  4 |  * User: smadhavan
  5 |  * Date: 9/20/18
  6 |  * Time: 2:07 PM
  7 |  */
  8 | require_once(dirname(__FILE__) . "/../Exceptions/RequestException.php");
  9 | 
 10 | /**
 11 |  * @param $app  Slim App - contains means for accessing request parameters
 12 |  * @return array JSON decoded PHP Arrays containing, query, sort, options and field list parameters
 13 |  *
 14 |  * Processes GET parameters
 15 |  * 'q' parameter is mandatory. s, o, f and format parameters are  optional
 16 |  */
 17 | function CheckGetParameters(array $req)
 18 | {
 19 |     // Make sure the 'q' parameter exists.
 20 |     if (!array_key_exists("q", $req) || $req['q'] == null) {
 21 |         throw new \Exceptions\RequestException("RQ1");
 22 |     }
 23 |     // Convert the query param to json, return error if empty or not valid
 24 |     $queryParam = json_decode($req['q'], true);
 25 | 
 26 |     if ($queryParam == null) {
 27 |         throw new \Exceptions\RequestException("RQ2");
 28 |     }
 29 |     // Ensure the query param only has one top-level object
 30 |     if (count($queryParam) != 1) {
 31 |         throw new \Exceptions\RequestException("RQ3");
 32 |     }
 33 | 
 34 |     // Look for an "f" parameter; it may not exist.
 35 |     $fieldsParam = null;
 36 |     if (array_key_exists("f", $req) && $req['f'] != null) {
 37 |         $fieldsParam = json_decode($req['f'], true);
 38 |         if ($fieldsParam == null) {
 39 |             throw new \Exceptions\RequestException("RF2");
 40 |         }
 41 |     }
 42 | 
 43 |     // Look for an "s" parameter; it may not exist.
 44 |     $sortParam = null;
 45 |     if (array_key_exists("s", $req) && $req['s'] != null) {
 46 |         $sortParam = json_decode($req['s'], true);
 47 |         if ($sortParam == null) {
 48 |             throw new \Exceptions\RequestException("RS2");
 49 |         }
 50 |     }
 51 | 
 52 |     // Look for an "o" parameter; it may not exist.
 53 |     $optionsParam = null;
 54 |     if (array_key_exists("o", $req) && $req['o'] != null) {
 55 |         $optionsParam = json_decode($req['o'], true);
 56 |         if ($optionsParam == null) {
 57 |             throw new \Exceptions\RequestException("RO2");
 58 |         }
 59 |     }
 60 | 
 61 |     $formatParam = 'json';
 62 |     // Look for a "format" parameter; it may not exist.
 63 |     if (array_key_exists("format", $req) && $req['format'] != null) {
 64 |         if (strtolower($req['format']) == 'json') {
 65 |             $formatParam = 'json';
 66 | 
 67 |         } elseif (strtolower($req['format']) == 'xml') {
 68 |             $formatParam = 'xml';
 69 | 
 70 |         } else
 71 |             throw new \Exceptions\RequestException("RFO4");
 72 |     }
 73 | 
 74 |     return array($queryParam, $fieldsParam, $sortParam, $optionsParam, $formatParam);
 75 | }
 76 | 
 77 | //
 78 | function CheckPostParameters($requestBody)
 79 | {
 80 |     $body = $requestBody;
 81 |     $bodyJSON = json_decode($body, true);
 82 |     if ($bodyJSON['q'] == null) {
 83 |         throw new \Exceptions\RequestException("POST1", $body);
 84 | 
 85 |     }
 86 |     //ErrorHandler::getHandler()->sendError(200, $bodyJSON);
 87 |     // Make sure the 'q' parameter exists.
 88 |     if ($bodyJSON['q'] == null) {
 89 |         throw new \Exceptions\RequestException("RQ1");
 90 |     }
 91 |     // Convert the query param to json, return error if empty or not valid
 92 |     $queryParam = $bodyJSON['q'];
 93 |     // Ensure the query param only has one top-level object
 94 |     if (count($queryParam) != 1) {
 95 |         throw new \Exceptions\RequestException("RQ3");
 96 |     }
 97 | 
 98 |     // Look for an "f" parameter; it may not exist.
 99 |     $fieldsParam = null;
100 |     if (array_key_exists('f', $bodyJSON))
101 |         $fieldsParam = $bodyJSON['f'];
102 | 
103 |     $sortParam = null;
104 |     // Look for an "s" parameter; it may not exist.
105 |     if (array_key_exists('s', $bodyJSON))
106 |         $sortParam = $bodyJSON['s'];
107 | 
108 |     $optionsParam = null;
109 |     // Look for an "o" parameter; it may not exist.
110 |     if (array_key_exists('o', $bodyJSON))
111 |         $optionsParam = $bodyJSON['o'];
112 | 
113 |     $formatParam = 'json';
114 |     // Look for a "format" parameter; it may not exist.
115 |     if (array_key_exists('format', $bodyJSON)) {
116 |         if ($bodyJSON['format'] == 'json') {
117 |             $formatParam = 'json';
118 | 
119 |         } elseif ($bodyJSON['format'] == 'xml') {
120 |             $formatParam = 'xml';
121 | 
122 |         } else
123 |             throw new \Exceptions\RequestException("RFO4");
124 |     }
125 | 
126 |     return array($queryParam, $fieldsParam, $sortParam, $optionsParam, $formatParam);
127 | 
128 | }
129 | 
130 | function FormatResults($formatParam, $results, $entitySpecs)
131 | {
132 |     if (strtolower($formatParam) == 'xml') {
133 |         $xml = new SimpleXMLElement('<root/>');
134 |         $results = array_to_xml($results, $xml, 'XXX', $entitySpecs)->asXML();
135 |         return $results;
136 |     } else
137 |         $results = json_encode($results);
138 |     return $results;
139 | }
140 | 
141 | function array_to_xml(array $arr, SimpleXMLElement $xml, $parentTag, $entitySpecs)
142 | {
143 |     foreach ($arr as $k => $v) {
144 | 
145 |         $attrArr = array();
146 |         $kArray = explode(' ', $k);
147 |         $tag = array_shift($kArray);
148 | 
149 |         if (count($kArray) > 0) {
150 |             foreach ($kArray as $attrValue) {
151 |                 $attrArr[] = explode('=', $attrValue);
152 |             }
153 |         }
154 | 
155 |         if (is_array($v)) {
156 |             if (is_numeric($k)) {
157 |                 $childTag = substr($parentTag, 0, -1); #Stripping last character which is expected to be an 's'. Doing this case we don't find the tag in the entity specs.
158 |                 foreach ($entitySpecs as $entity)
159 |                     if ($entity['group_name'] == $parentTag)
160 |                         $childTag = $entity['entity_name'];
161 |                 $child = $xml->addChild($childTag);
162 |                 array_to_xml($v, $child, $tag, $entitySpecs);
163 |             } else {
164 |                 $child = $xml->addChild($tag);
165 |                 if (isset($attrArr)) {
166 |                     foreach ($attrArr as $attrArrV) {
167 |                         $child->addAttribute($attrArrV[0], $attrArrV[1]);
168 |                     }
169 |                 }
170 |                 array_to_xml($v, $child, $tag, $entitySpecs);
171 |             }
172 |         } else {
173 |             $v = str_replace('&', '&amp;', $v);
174 |             $child = $xml->addChild($tag, $v);
175 |             if (isset($attrArr)) {
176 |                 foreach ($attrArr as $attrArrV) {
177 |                     $child->addAttribute($attrArrV[0], $attrArrV[1]);
178 |                 }
179 |             }
180 |         }
181 |     }
182 | 
183 |     return $xml;
184 | }


--------------------------------------------------------------------------------
/querymodule/app/specs/assignee-entity-specs.json:
--------------------------------------------------------------------------------
  1 | [
  2 |   {
  3 |     "entity_name": "assignee",
  4 |     "group_name": "assignees",
  5 |     "keyId": "assignee_key_id",
  6 |     "distinctCountId": "assignee_key_id",
  7 |     "default_fields": [
  8 |       "assignee_id",
  9 |       "assignee_first_name",
 10 |       "assignee_last_name",
 11 |       "assignee_organization"
 12 |     ],
 13 |     "join": " assignee left outer join patent_assignee on assignee.assignee_id=patent_assignee.assignee_id"
 14 |   },
 15 |   {
 16 |     "entity_name": "location",
 17 |     "group_name": "locations",
 18 |     "keyId": "location_key_id",
 19 |     "distinctCountId": "location_key_id",
 20 |     "join": " left outer JOIN location_assignee on assignee.assignee_id=location_assignee.assignee_id left outer join location as locationA on location_assignee.location_id=locationA.location_id"
 21 |   },
 22 |   {
 23 |     "entity_name": "patent",
 24 |     "group_name": "patents",
 25 |     "keyId": "patent_id",
 26 |     "distinctCountId": "patent_id",
 27 |     "join": "left outer JOIN patent on patent_assignee.patent_id=patent.patent_id"
 28 |   },
 29 |   {
 30 |     "entity_name": "inventor",
 31 |     "group_name": "inventors",
 32 |     "keyId": "inventor_key_id",
 33 |     "distinctCountId": "inventor_key_id",
 34 |     "join": "left outer join patent_inventor on patent_assignee.patent_id=patent_inventor.patent_id left outer join inventor ON patent_inventor.inventor_id=inventor.inventor_id left outer join location as locationI on patent_inventor.location_id=locationI.location_id left outer join assignee_inventor on assignee.assignee_id=assignee_inventor.assignee_id and inventor.inventor_id=assignee_inventor.inventor_id"
 35 |   },
 36 |   {
 37 |     "entity_name": "rawinventor",
 38 |     "group_name": "rawinventors",
 39 |     "keyId": "rawinventor_key_id",
 40 |     "distinctCountId": "rawinventor_key_id",
 41 |     "join": "left outer join inventor_rawinventor on inventor_rawinventor.patent_id = patent_assignee.patent_id"
 42 |   },
 43 |   {
 44 |     "entity_name": "application",
 45 |     "group_name": "applications",
 46 |     "keyId": "app_id",
 47 |     "distinctCountId": "app_id",
 48 |     "join": "left outer join application on patent_assignee.patent_id=application.patent_id"
 49 |   },
 50 |   {
 51 |     "entity_name": "ipc",
 52 |     "group_name": "IPCs",
 53 |     "keyId": "",
 54 |     "distinctCountId": "ipc_class",
 55 |     "join": "left outer join ipcr on patent_assignee.patent_id=ipcr.patent_id"
 56 |   },
 57 |   {
 58 |     "entity_name": "uspc",
 59 |     "group_name": "uspcs",
 60 |     "keyId": "",
 61 |     "distinctCountId": "uspc_mainclass_id",
 62 |     "join": "left outer join uspc_current_mainclass_copy on patent_assignee.patent_id=uspc_current_mainclass_copy.patent_id left outer join uspc_current_copy on uspc_current_mainclass_copy.patent_id=uspc_current_copy.patent_id and uspc_current_mainclass_copy.mainclass_id=uspc_current_copy.mainclass_id left outer join uspc_mainclass on uspc_current_mainclass_copy.mainclass_id=uspc_mainclass.id left outer join uspc_subclass on uspc_current_copy.subclass_id=uspc_subclass.id left outer join assignee_uspc_mainclass on assignee.assignee_id=assignee_uspc_mainclass.assignee_id and uspc_current_mainclass_copy.mainclass_id=assignee_uspc_mainclass.mainclass_id"
 63 |   },
 64 |   {
 65 |     "entity_name": "cpc",
 66 |     "group_name": "cpcs",
 67 |     "keyId": "",
 68 |     "distinctCountId": "cpc_group_id",
 69 |     "join": "left outer join cpc_current_group_copy on patent_assignee.patent_id=cpc_current_group_copy.patent_id left outer join cpc_group on cpc_current_group_copy.group_id=cpc_group.id left outer join cpc_current_copy on cpc_current_group_copy.patent_id=cpc_current_copy.patent_id and cpc_group.id=cpc_current_copy.group_id  left outer join cpc_subsection on cpc_current_copy.subsection_id=cpc_subsection.id left outer join cpc_subgroup on cpc_current_copy.subgroup_id=cpc_subgroup.id left outer join assignee_cpc_group on assignee.assignee_id=assignee_cpc_group.assignee_id and cpc_current_group_copy.group_id=assignee_cpc_group.group_id"
 70 |   },
 71 |   {
 72 |     "entity_name": "nber",
 73 |     "group_name": "nbers",
 74 |     "keyId": "",
 75 |     "distinctCountId": "nber_subcategory_id",
 76 |     "join": "left outer join nber_copy on patent_assignee.patent_id=nber_copy.patent_id left outer join nber_category on nber_copy.category_id=nber_category.id left outer join nber_subcategory on nber_copy.subcategory_id=nber_subcategory.id left outer join assignee_nber_subcategory on assignee.assignee_id=assignee_nber_subcategory.assignee_id and nber_copy.subcategory_id=assignee_nber_subcategory.subcategory_id"
 77 |   },
 78 |   {
 79 |     "entity_name": "year",
 80 |     "group_name": "years",
 81 |     "keyId": "",
 82 |     "distinctCountId": "year_id",
 83 |     "join": "left outer JOIN patent as patent_year on patent_assignee.patent_id=patent_year.patent_id left outer join assignee_year on assignee.assignee_id=assignee_year.assignee_id and patent_year.year=assignee_year.patent_year"
 84 |   },
 85 |   {
 86 |     "entity_name": "wipo",
 87 |     "group_name": "wipos",
 88 |     "keyId": "",
 89 |     "distinctCountId": "wipo_field_id",
 90 |     "join": "left outer join wipo on patent_assignee.patent_id=wipo.patent_id left outer join wipo_field on wipo.field_id=wipo_field.id"
 91 |   },
 92 |   {
 93 |     "entity_name": "government_interest",
 94 |     "group_name": "gov_interests",
 95 |     "keyId": "",
 96 |     "distinctCountId": "govint_patent_id",
 97 |     "join": "left outer join government_interest on patent_assignee.patent_id=government_interest.patent_id left outer join patent_govintorg on patent_assignee.patent_id=patent_govintorg.patent_id left outer join patent_contractawardnumber on patent_assignee.patent_id=patent_contractawardnumber.patent_id left outer join government_organization on patent_govintorg.organization_id=government_organization.organization_id"
 98 |   },
 99 |   {
100 |     "entity_name": "lawyer",
101 |     "group_name": "lawyers",
102 |     "keyId": "",
103 |     "distinctCountId": "lawyer_id",
104 |     "join": "left outer join patent_lawyer ON patent_assignee.patent_id=patent_lawyer.patent_id left outer join lawyer on lawyer.lawyer_id=patent_lawyer.lawyer_id"
105 |   },
106 |   {
107 |     "entity_name": "examiner",
108 |     "group_name": "examiners",
109 |     "keyId": "",
110 |     "distinctCountId": "examiner_id",
111 |     "join": "left outer join patent_examiner on patent_examiner.patent_id=patent_assignee.patent_id left outer join examiner on examiner.examiner_id=patent_examiner.examiner_id"
112 |   },
113 |   {
114 |     "entity_name": "foreign_prior",
115 |     "group_name": "foreign_priority",
116 |     "keyId": "",
117 |     "distinctCountId": "foreign_doc_number",
118 |     "join": "left outer join foreignpriority on foreignpriority.patent_id=patent_assignee.patent_id"
119 |   },
120 |   {
121 |     "entity_name": "pct_dat",
122 |     "group_name": "pct_data",
123 |     "keyId": "",
124 |     "distinctCountId": "pct_id",
125 |     "join": "left outer join pctdata on pctdata.patent_id=patent_assignee.patent_id"
126 |   }
127 | ]


--------------------------------------------------------------------------------
/querymodule/app/specs/cpc-entity-specs.json:
--------------------------------------------------------------------------------
  1 | [
  2 |   {
  3 |     "entity_name": "cpc_subsection",
  4 |     "group_name": "cpc_subsections",
  5 |     "keyId": "cpc_subsection_id",
  6 |     "distinctCountId": "cpc_subsection_id",
  7 |     "default_fields": [
  8 |       "cpc_subsection_id",
  9 |       "cpc_subsection_title"
 10 |     ],
 11 |     "join": "cpc_subsection inner join cpc_current_subsection_copy on cpc_subsection.id=cpc_current_subsection_copy.subsection_id"
 12 |   },
 13 |   {
 14 |     "entity_name": "cpc_subgroup",
 15 |     "group_name": "cpc_subgroups",
 16 |     "keyId": "cpc_subgroup_id",
 17 |     "distinctCountId": "cpc_subgroup_id",
 18 |     "join": "  left outer join cpc_current_copy on cpc_current_subsection_copy.patent_id=cpc_current_copy.patent_id and cpc_subsection.id=cpc_current_copy.subsection_id inner join cpc_subgroup on cpc_current_copy.subgroup_id=cpc_subgroup.id inner join cpc_group on cpc_current_copy.group_id=cpc_group.id"
 19 |   },
 20 |   {
 21 |     "entity_name": "patent",
 22 |     "group_name": "patents",
 23 |     "keyId": "patent_id",
 24 |     "distinctCountId": "patent_id",
 25 |     "join": "left outer JOIN patent on cpc_current_subsection_copy.patent_id=patent.patent_id"
 26 |   },
 27 |   {
 28 |     "entity_name": "assignee",
 29 |     "group_name": "assignees",
 30 |     "keyId": "assignee_key_id",
 31 |     "distinctCountId": "assignee_key_id",
 32 |     "join": "left outer join patent_assignee on cpc_current_subsection_copy.patent_id=patent_assignee.patent_id left outer JOIN assignee on patent_assignee.assignee_id=assignee.assignee_id left outer join location as locationA on patent_assignee.location_id=locationA.location_id left outer join assignee_cpc_subsection on cpc_current_subsection_copy.subsection_id=assignee_cpc_subsection.subsection_id and assignee.assignee_id=assignee_cpc_subsection.assignee_id"
 33 |   },
 34 |   {
 35 |     "entity_name": "inventor",
 36 |     "group_name": "inventors",
 37 |     "keyId": "inventor_key_id",
 38 |     "distinctCountId": "inventor_key_id",
 39 |     "join": "left outer join patent_inventor on cpc_current_subsection_copy.patent_id=patent_inventor.patent_id left outer join inventor ON patent_inventor.inventor_id=inventor.inventor_id left outer join location as locationI on patent_inventor.location_id=locationI.location_id left outer join inventor_cpc_subsection on cpc_current_subsection_copy.subsection_id=inventor_cpc_subsection.subsection_id and inventor.inventor_id=inventor_cpc_subsection.inventor_id"
 40 |   },
 41 |   {
 42 |     "entity_name": "rawinventor",
 43 |     "group_name": "rawinventors",
 44 |     "keyId": "rawinventor_key_id",
 45 |     "distinctCountId": "rawinventor_key_id",
 46 |     "join": "left outer join inventor_rawinventor on cpc_current_subsection_copy.patent_id=inventor_rawinventor.patent_id"
 47 |   },
 48 |   {
 49 |     "entity_name": "application",
 50 |     "group_name": "applications",
 51 |     "keyId": "app_id",
 52 |     "distinctCountId": "app_id",
 53 |     "join": "left outer join application on cpc_current_subsection_copy.patent_id=application.patent_id"
 54 |   },
 55 |   {
 56 |     "entity_name": "ipc",
 57 |     "group_name": "IPCs",
 58 |     "keyId": "",
 59 |     "distinctCountId": "ipc_class",
 60 |     "join": "left outer join ipcr on cpc_current_subsection_copy.patent_id=ipcr.patent_id"
 61 |   },
 62 |   {
 63 |     "entity_name": "uspc",
 64 |     "group_name": "uspcs",
 65 |     "keyId": "",
 66 |     "distinctCountId": "uspc_mainclass_id",
 67 |     "join": "left outer join uspc_current_mainclass_copy on cpc_current_subsection_copy.patent_id=uspc_current_mainclass_copy.patent_id left outer join uspc_current_copy on uspc_current_mainclass_copy.patent_id=uspc_current_copy.patent_id and uspc_current_mainclass_copy.mainclass_id=uspc_current_copy.mainclass_id left outer join uspc_mainclass on uspc_current_mainclass_copy.mainclass_id=uspc_mainclass.id left outer join uspc_subclass on uspc_current_copy.subclass_id=uspc_subclass.id"
 68 |   },
 69 |   {
 70 |     "entity_name": "nber",
 71 |     "group_name": "nbers",
 72 |     "keyId": "",
 73 |     "distinctCountId": "nber_subcategory_id",
 74 |     "join": "left outer join nber_copy on cpc_current_subsection_copy.patent_id=nber_copy.patent_id left outer join nber_category on nber_copy.category_id=nber_category.id left outer join nber_subcategory on nber_copy.subcategory_id=nber_subcategory.id"
 75 |   },
 76 |   {
 77 |     "entity_name": "year",
 78 |     "group_name": "years",
 79 |     "keyId": "",
 80 |     "distinctCountId": "year_id",
 81 |     "join": "left outer JOIN patent as patent_year on cpc_current_subsection_copy.patent_id=patent_year.patent_id left outer join cpc_current_subsection_patent_year on patent_year.year=cpc_current_subsection_patent_year.patent_year and cpc_current_subsection_copy.subsection_id=cpc_current_subsection_patent_year.subsection_id"
 82 |   },
 83 |   {
 84 |     "entity_name": "wipo",
 85 |     "group_name": "wipos",
 86 |     "keyId": "",
 87 |     "distinctCountId": "wipo_field_id",
 88 |     "join": "left outer join wipo on cpc_current_subsection_copy.patent_id=wipo.patent_id left outer join wipo_field on wipo.field_id=wipo_field.id"
 89 |   },
 90 |   {
 91 |     "entity_name": "government_interest",
 92 |     "group_name": "gov_interests",
 93 |     "keyId": "",
 94 |     "distinctCountId": "govint_patent_id",
 95 |     "join": "left outer join government_interest on cpc_current_subsection_copy.patent_id=government_interest.patent_id left outer join patent_govintorg on cpc_current_subsection_copy.patent_id=patent_govintorg.patent_id left outer join patent_contractawardnumber on cpc_current_subsection_copy.patent_id=patent_contractawardnumber.patent_id left outer join government_organization on patent_govintorg.organization_id=government_organization.organization_id"
 96 |   },
 97 |   {
 98 |     "entity_name": "lawyer",
 99 |     "group_name": "lawyers",
100 |     "keyId": "",
101 |     "distinctCountId": "lawyer_id",
102 |     "join": "left outer join patent_lawyer ON patent_lawyer.patent_id=cpc_current_subsection_copy.patent_id left outer join lawyer on lawyer.lawyer_id=patent_lawyer.lawyer_id"
103 |   },
104 |   {
105 |     "entity_name": "examiner",
106 |     "group_name": "examiners",
107 |     "keyId": "",
108 |     "distinctCountId": "examiner_id",
109 |     "join": "left outer join patent_examiner on patent_examiner.patent_id=cpc_current_subsection_copy.patent_id left outer join examiner on examiner.examiner_id=patent_examiner.examiner_id"
110 |   },
111 |   {
112 |     "entity_name": "foreign_prior",
113 |     "group_name": "foreign_priority",
114 |     "keyId": "",
115 |     "distinctCountId": "foreign_doc_number",
116 |     "join": "left outer join foreignpriority on foreignpriority.patent_id=cpc_current_subsection_copy.patent_id"
117 |   },
118 |   {
119 |     "entity_name": "pct_dat",
120 |     "group_name": "pct_data",
121 |     "keyId": "",
122 |     "distinctCountId": "pct_id",
123 |     "join": "left outer join pctdata on pctdata.patent_id=cpc_current_subsection_copy.patent_id"
124 |   }
125 | ]


--------------------------------------------------------------------------------
/querymodule/app/specs/cpc-group-entity-specs.json:
--------------------------------------------------------------------------------
  1 | [
  2 |   {
  3 |     "entity_name": "cpc_group",
  4 |     "group_name": "cpc_groups",
  5 |     "keyId": "cpc_group_id",
  6 |     "distinctCountId": "cpc_group_id",
  7 |     "default_fields": [
  8 |       "cpc_group_id",
  9 |       "cpc_group_title"
 10 |     ],
 11 |     "join": "cpc_group inner join cpc_current_group_copy on cpc_group.id=cpc_current_group_copy.group_id"
 12 |   },
 13 |   {
 14 |     "entity_name": "cpc_subgroup",
 15 |     "group_name": "cpc_subgroups",
 16 |     "keyId": "cpc_subgroup_id",
 17 |     "distinctCountId": "cpc_subgroup_id",
 18 |     "join": "  left outer join cpc_current_copy on cpc_current_group_copy.patent_id=cpc_current_copy.patent_id and cpc_group.id=cpc_current_copy.group_id inner join cpc_subgroup on cpc_current_copy.subgroup_id=cpc_subgroup.id inner join cpc_subsection on cpc_current_copy.subsection_id=cpc_subsection.id"
 19 |   },
 20 |   {
 21 |     "entity_name": "patent",
 22 |     "group_name": "patents",
 23 |     "keyId": "patent_id",
 24 |     "distinctCountId": "patent_id",
 25 |     "join": "left outer JOIN patent on cpc_current_group_copy.patent_id=patent.patent_id"
 26 |   },
 27 |   {
 28 |     "entity_name": "assignee",
 29 |     "group_name": "assignees",
 30 |     "keyId": "assignee_key_id",
 31 |     "distinctCountId": "assignee_key_id",
 32 |     "join": "left outer join patent_assignee on cpc_current_group_copy.patent_id=patent_assignee.patent_id left outer JOIN assignee on patent_assignee.assignee_id=assignee.assignee_id left outer join location as locationA on patent_assignee.location_id=locationA.location_id left outer join assignee_cpc_group on cpc_current_group_copy.group_id=assignee_cpc_group.group_id and assignee.assignee_id=assignee_cpc_group.assignee_id"
 33 |   },
 34 |   {
 35 |     "entity_name": "inventor",
 36 |     "group_name": "inventors",
 37 |     "keyId": "inventor_key_id",
 38 |     "distinctCountId": "inventor_key_id",
 39 |     "join": "left outer join patent_inventor on cpc_current_group_copy.patent_id=patent_inventor.patent_id left outer join inventor ON patent_inventor.inventor_id=inventor.inventor_id left outer join location as locationI on patent_inventor.location_id=locationI.location_id left outer join inventor_cpc_group on cpc_current_group_copy.group_id=inventor_cpc_group.group_id and inventor.inventor_id=inventor_cpc_group.inventor_id"
 40 |   },
 41 |   {
 42 |     "entity_name": "rawinventor",
 43 |     "group_name": "rawinventors",
 44 |     "keyId": "rawinventor_key_id",
 45 |     "distinctCountId": "rawinventor_key_id",
 46 |     "join": "left outer join inventor_rawinventor on cpc_current_group_copy.patent_id=inventor_rawinventor.patent_id"
 47 |   },
 48 |   {
 49 |     "entity_name": "application",
 50 |     "group_name": "applications",
 51 |     "keyId": "app_id",
 52 |     "distinctCountId": "app_id",
 53 |     "join": "left outer join application on cpc_current_group_copy.patent_id=application.patent_id"
 54 |   },
 55 |   {
 56 |     "entity_name": "ipc",
 57 |     "group_name": "IPCs",
 58 |     "keyId": "",
 59 |     "distinctCountId": "ipc_class",
 60 |     "join": "left outer join ipcr on cpc_current_group_copy.patent_id=ipcr.patent_id"
 61 |   },
 62 |   {
 63 |     "entity_name": "uspc",
 64 |     "group_name": "uspcs",
 65 |     "keyId": "",
 66 |     "distinctCountId": "uspc_mainclass_id",
 67 |     "join": "left outer join uspc_current_mainclass_copy on cpc_current_group_copy.patent_id=uspc_current_mainclass_copy.patent_id left outer join uspc_current_copy on uspc_current_mainclass_copy.patent_id=uspc_current_copy.patent_id and uspc_current_mainclass_copy.mainclass_id=uspc_current_copy.mainclass_id left outer join uspc_mainclass on uspc_current_mainclass_copy.mainclass_id=uspc_mainclass.id left outer join uspc_subclass on uspc_current_copy.subclass_id=uspc_subclass.id"
 68 |   },
 69 |   {
 70 |     "entity_name": "nber",
 71 |     "group_name": "nbers",
 72 |     "keyId": "",
 73 |     "distinctCountId": "nber_subcategory_id",
 74 |     "join": "left outer join nber_copy on cpc_current_group_copy.patent_id=nber_copy.patent_id left outer join nber_category on nber_copy.category_id=nber_category.id left outer join nber_subcategory on nber_copy.subcategory_id=nber_subcategory.id"
 75 |   },
 76 |   {
 77 |     "entity_name": "year",
 78 |     "group_name": "years",
 79 |     "keyId": "",
 80 |     "distinctCountId": "year_id",
 81 |     "join": "left outer JOIN patent as patent_year on cpc_current_group_copy.patent_id=patent_year.patent_id left outer join cpc_current_group_patent_year on patent_year.year=cpc_current_group_patent_year.patent_year and cpc_current_group_copy.group_id=cpc_current_group_patent_year.group_id"
 82 |   },
 83 |   {
 84 |     "entity_name": "wipo",
 85 |     "group_name": "wipos",
 86 |     "keyId": "",
 87 |     "distinctCountId": "wipo_field_id",
 88 |     "join": "left outer join wipo on cpc_current_group_copy.patent_id=wipo.patent_id left outer join wipo_field on wipo.field_id=wipo_field.id"
 89 |   },
 90 |   {
 91 |     "entity_name": "government_interest",
 92 |     "group_name": "gov_interests",
 93 |     "keyId": "",
 94 |     "distinctCountId": "govint_patent_id",
 95 |     "join": "left outer join government_interest on cpc_current_group_copy.patent_id=government_interest.patent_id left outer join patent_govintorg on cpc_current_group_copy.patent_id=patent_govintorg.patent_id left outer join patent_contractawardnumber on cpc_current_group_copy.patent_id=patent_contractawardnumber.patent_id left outer join government_organization on patent_govintorg.organization_id=government_organization.organization_id"
 96 |   },
 97 |   {
 98 |     "entity_name": "lawyer",
 99 |     "group_name": "lawyers",
100 |     "keyId": "",
101 |     "distinctCountId": "lawyer_id",
102 |     "join": "left outer join patent_lawyer ON patent_lawyer.patent_id=cpc_current_group_copy.patent_id left outer join lawyer on lawyer.lawyer_id=patent_lawyer.lawyer_id"
103 |   },
104 |   {
105 |     "entity_name": "examiner",
106 |     "group_name": "examiners",
107 |     "keyId": "",
108 |     "distinctCountId": "examiner_id",
109 |     "join": "left outer join patent_examiner on patent_examiner.patent_id=cpc_current_group_copy.patent_id left outer join examiner on examiner.examiner_id=patent_examiner.examiner_id"
110 |   },
111 |   {
112 |     "entity_name": "foreign_prior",
113 |     "group_name": "foreign_priority",
114 |     "keyId": "",
115 |     "distinctCountId": "foreign_doc_number",
116 |     "join": "left outer join foreignpriority on foreignpriority.patent_id=cpc_current_group_copy.patent_id"
117 |   },
118 |   {
119 |     "entity_name": "pct_dat",
120 |     "group_name": "pct_data",
121 |     "keyId": "",
122 |     "distinctCountId": "pct_id",
123 |     "join": "left outer join pctdata on pctdata.patent_id=cpc_current_group_copy.patent_id"
124 |   }
125 | ]


--------------------------------------------------------------------------------
/querymodule/app/specs/inventor-entity-specs.json:
--------------------------------------------------------------------------------
  1 | [
  2 |   {
  3 |     "entity_name": "inventor",
  4 |     "group_name": "inventors",
  5 |     "keyId": "inventor_key_id",
  6 |     "distinctCountId": "inventor_key_id",
  7 |     "default_fields": [
  8 |       "inventor_id",
  9 |       "inventor_first_name",
 10 |       "inventor_last_name"
 11 |     ],
 12 |     "join": " inventor left outer join patent_inventor on inventor.inventor_id=patent_inventor.inventor_id"
 13 |   },
 14 |   {
 15 |     "entity_name": "rawinventor",
 16 |     "group_name": "rawinventors",
 17 |     "keyId": "rawinventor_key_id",
 18 |     "distinctCountId": "rawinventor_key_id",
 19 |     "join": " left outer join inventor_rawinventor on inventor_rawinventor.inventor_id = inventor.inventor_id and inventor_rawinventor.patent_id = patent_inventor.patent_id"
 20 |   },
 21 |   {
 22 |     "entity_name": "location",
 23 |     "group_name": "locations",
 24 |     "keyId": "location_key_id",
 25 |     "distinctCountId": "location_key_id",
 26 |     "join": " left outer JOIN location_inventor on inventor.inventor_id=location_inventor.inventor_id left outer join location as locationI on location_inventor.location_id=locationI.location_id"
 27 |   },
 28 |   {
 29 |     "entity_name": "patent",
 30 |     "group_name": "patents",
 31 |     "keyId": "patent_id",
 32 |     "distinctCountId": "patent_id",
 33 |     "join": "left outer JOIN patent on patent_inventor.patent_id=patent.patent_id"
 34 |   },
 35 |   {
 36 |     "entity_name": "assignee",
 37 |     "group_name": "assignees",
 38 |     "keyId": "assignee_key_id",
 39 |     "distinctCountId": "assignee_key_id",
 40 |     "join": "left outer join patent_assignee on patent_inventor.patent_id=patent_assignee.patent_id left outer join assignee ON patent_assignee.assignee_id=assignee.assignee_id left outer JOIN location as locationA on patent_assignee.location_id=locationA.location_id left outer join assignee_inventor on patent_inventor.inventor_id=assignee_inventor.inventor_id and assignee.assignee_id=assignee_inventor.assignee_id"
 41 |   },
 42 |   {
 43 |     "entity_name": "application",
 44 |     "group_name": "applications",
 45 |     "keyId": "app_id",
 46 |     "distinctCountId": "app_id",
 47 |     "join": "left outer join application on patent_inventor.patent_id=application.patent_id"
 48 |   },
 49 |   {
 50 |     "entity_name": "coinventor",
 51 |     "group_name": "coinventors",
 52 |     "keyId": "coinventor_key_id",
 53 |     "distinctCountId": "coinventor_key_id",
 54 |     "join": "left outer join patent_inventor as copatent_inventor on copatent_inventor.patent_id=patent_inventor.patent_id and copatent_inventor.inventor_id<>patent_inventor.inventor_id left outer join inventor as coinventor on copatent_inventor.inventor_id=coinventor.inventor_id left outer join location_inventor as location_coinventor on coinventor.inventor_id=location_coinventor.inventor_id left outer join location as locationCO on location_coinventor.location_id=locationCO.location_id left outer join inventor_coinventor on inventor.inventor_id=inventor_coinventor.inventor_id and coinventor.inventor_id=inventor_coinventor.coinventor_id"
 55 |   },
 56 |   {
 57 |     "entity_name": "ipc",
 58 |     "group_name": "IPCs",
 59 |     "keyId": "",
 60 |     "distinctCountId": "ipc_class",
 61 |     "join": "left outer join ipcr on patent_inventor.patent_id=ipcr.patent_id"
 62 |   },
 63 |   {
 64 |     "entity_name": "uspc",
 65 |     "group_name": "uspcs",
 66 |     "keyId": "",
 67 |     "distinctCountId": "uspc_mainclass_id",
 68 |     "join": "left outer join uspc_current_mainclass_copy on patent_inventor.patent_id=uspc_current_mainclass_copy.patent_id left outer join uspc_current_copy on uspc_current_mainclass_copy.patent_id=uspc_current_copy.patent_id and uspc_current_mainclass_copy.mainclass_id=uspc_current_copy.mainclass_id left outer join uspc_mainclass on uspc_current_mainclass_copy.mainclass_id=uspc_mainclass.id left outer join uspc_subclass on uspc_current_copy.subclass_id=uspc_subclass.id left outer join inventor_uspc_mainclass on inventor.inventor_id=inventor_uspc_mainclass.inventor_id and uspc_current_mainclass_copy.mainclass_id=inventor_uspc_mainclass.mainclass_id"
 69 |   },
 70 |   {
 71 |     "entity_name": "cpc",
 72 |     "group_name": "cpcs",
 73 |     "keyId": "",
 74 |     "distinctCountId": "cpc_group_id",
 75 |     "join": "left outer join cpc_current_group_copy on patent_inventor.patent_id=cpc_current_group_copy.patent_id left outer join cpc_group on cpc_current_group_copy.group_id=cpc_group.id  left outer join cpc_current_copy on cpc_current_group_copy.patent_id=cpc_current_copy.patent_id and cpc_group.id=cpc_current_copy.group_id left outer join cpc_subsection on cpc_current_copy.subsection_id=cpc_subsection.id left outer join cpc_subgroup on cpc_current_copy.subgroup_id=cpc_subgroup.id left outer join inventor_cpc_group on inventor.inventor_id=inventor_cpc_group.inventor_id and cpc_current_group_copy.group_id=inventor_cpc_group.group_id"
 76 |   },
 77 |   {
 78 |     "entity_name": "nber",
 79 |     "group_name": "nbers",
 80 |     "keyId": "",
 81 |     "distinctCountId": "nber_subcategory_id",
 82 |     "join": "left outer join nber_copy on patent_inventor.patent_id=nber_copy.patent_id left outer join nber_category on nber_copy.category_id=nber_category.id left outer join nber_subcategory on nber_copy.subcategory_id=nber_subcategory.id left outer join inventor_nber_subcategory on inventor.inventor_id=inventor_nber_subcategory.inventor_id and nber_copy.subcategory_id=inventor_nber_subcategory.subcategory_id"
 83 |   },
 84 |   {
 85 |     "entity_name": "year",
 86 |     "group_name": "years",
 87 |     "keyId": "",
 88 |     "distinctCountId": "year_id",
 89 |     "join": "left outer JOIN patent as patent_year on patent_inventor.patent_id=patent_year.patent_id left outer join inventor_year on inventor.inventor_id=inventor_year.inventor_id and patent_year.year=inventor_year.patent_year"
 90 |   },
 91 |   {
 92 |     "entity_name": "wipo",
 93 |     "group_name": "wipos",
 94 |     "keyId": "",
 95 |     "distinctCountId": "wipo_field_id",
 96 |     "join": "left outer join wipo on patent_inventor.patent_id=wipo.patent_id left outer join wipo_field on wipo.field_id=wipo_field.id"
 97 |   },
 98 |   {
 99 |     "entity_name": "government_interest",
100 |     "group_name": "gov_interests",
101 |     "keyId": "",
102 |     "distinctCountId": "govint_patent_id",
103 |     "join": "left outer join government_interest on patent_inventor.patent_id=government_interest.patent_id left outer join patent_govintorg on patent_inventor.patent_id=patent_govintorg.patent_id left outer join patent_contractawardnumber on patent_inventor.patent_id=patent_contractawardnumber.patent_id left outer join government_organization on patent_govintorg.organization_id=government_organization.organization_id"
104 |   },
105 |   {
106 |     "entity_name": "lawyer",
107 |     "group_name": "lawyers",
108 |     "keyId": "",
109 |     "distinctCountId": "lawyer_id",
110 |     "join": "left outer join patent_lawyer ON patent_inventor.patent_id=patent_lawyer.patent_id left outer join lawyer on lawyer.lawyer_id=patent_lawyer.lawyer_id"
111 |   },
112 |   {
113 |     "entity_name": "examiner",
114 |     "group_name": "examiners",
115 |     "keyId": "",
116 |     "distinctCountId": "examiner_id",
117 |     "join": "left outer join patent_examiner on patent_examiner.patent_id=patent_inventor.patent_id left outer join examiner on examiner.examiner_id=patent_examiner.examiner_id"
118 |   },
119 |   {
120 |     "entity_name": "foreign_prior",
121 |     "group_name": "foreign_priority",
122 |     "keyId": "",
123 |     "distinctCountId": "foreign_doc_number",
124 |     "join": "left outer join foreignpriority on foreignpriority.patent_id=patent_inventor.patent_id"
125 |   },
126 |   {
127 |     "entity_name": "pct_dat",
128 |     "group_name": "pct_data",
129 |     "keyId": "",
130 |     "distinctCountId": "pct_id",
131 |     "join": "left outer join pctdata on pctdata.patent_id=patent_inventor.patent_id"
132 |   }
133 | ]


--------------------------------------------------------------------------------
/querymodule/app/specs/location-entity-specs.json:
--------------------------------------------------------------------------------
  1 | [
  2 |   {
  3 |     "entity_name": "location",
  4 |     "group_name": "locations",
  5 |     "keyId": "location_key_id",
  6 |     "distinctCountId": "location_key_id",
  7 |     "default_fields": [
  8 |       "location_id",
  9 |       "location_city",
 10 |       "location_state",
 11 |       "location_country"
 12 |     ],
 13 |     "join": "location left join patent_inventor using(location_id) left join patent using(patent_id)"
 14 |   },
 15 |   {
 16 |     "entity_name": "patent",
 17 |     "group_name": "patents",
 18 |     "keyId": "patent_id",
 19 |     "distinctCountId": "patent_id",
 20 |     "join": ""
 21 |   },
 22 |   {
 23 |     "entity_name": "inventor",
 24 |     "group_name": "inventors",
 25 |     "keyId": "inventor_key_id",
 26 |     "distinctCountId": "inventor_key_id",
 27 |     "join": "left join inventor using(inventor_id) left outer join location_inventor on location.location_id=location_inventor.location_id and inventor.inventor_id=location_inventor.inventor_id"
 28 |   },
 29 |   {
 30 |     "entity_name": "rawinventor",
 31 |     "group_name": "rawinventors",
 32 |     "keyId": "rawinventor_key_id",
 33 |     "distinctCountId": "rawinventor_key_id",
 34 |     "join": "left outer join inventor_rawinventor on inventor_rawinventor.patent_id = patent.patent_id"
 35 |   },
 36 |   {
 37 |     "entity_name": "assignee",
 38 |     "group_name": "assignees",
 39 |     "keyId": "assignee_key_id",
 40 |     "distinctCountId": "assignee_key_id",
 41 |     "join": "left join patent_assignee on location.location_id=patent_assignee.location_id left join assignee using(assignee_id) left outer join location_assignee on location.location_id=location_assignee.location_id and assignee.assignee_id=location_assignee.assignee_id"
 42 |   },
 43 |   {
 44 |     "entity_name": "application",
 45 |     "group_name": "applications",
 46 |     "keyId": "app_id",
 47 |     "distinctCountId": "app_id",
 48 |     "join": "left outer join application on application.patent_id=patent_inventor.patent_id"
 49 |   },
 50 |   {
 51 |     "entity_name": "ipc",
 52 |     "group_name": "IPCs",
 53 |     "keyId": "",
 54 |     "distinctCountId": "ipc_class",
 55 |     "join": "left outer join ipcr using(patent_id)"
 56 |   },
 57 |   {
 58 |     "entity_name": "application_citation",
 59 |     "group_name": "application_citations",
 60 |     "keyId": "",
 61 |     "distinctCountId": "appcit_app_number",
 62 |     "join": "left outer join usapplicationcitation on patent.patent_id=usapplicationcitation.citing_patent_id "
 63 |   },
 64 |   {
 65 |     "entity_name": "cited_patent",
 66 |     "group_name": "cited_patents",
 67 |     "keyId": "",
 68 |     "distinctCountId": "cited_patent_id",
 69 |     "join": "left outer join uspatentcitation as patentcit_fromciting_tocited on patent.patent_id=patentcit_fromciting_tocited.citing_patent_id left outer join patent as citedpatent on patentcit_fromciting_tocited.cited_patent_id=citedpatent.patent_id"
 70 |   },
 71 |   {
 72 |     "entity_name": "citedby_patent",
 73 |     "group_name": "citedby_patents",
 74 |     "keyId": "",
 75 |     "distinctCountId": "citedby_patent_id",
 76 |     "join": "left outer join uspatentcitation as patentcit_fromcited_tociting on patent.patent_id=patentcit_fromcited_tociting.cited_patent_id left outer join patent as citingpatent on patentcit_fromcited_tociting.citing_patent_id=citingpatent.patent_id"
 77 |   },
 78 |   {
 79 |     "entity_name": "uspc",
 80 |     "group_name": "uspcs",
 81 |     "keyId": "",
 82 |     "distinctCountId": "uspc_mainclass_id",
 83 |     "join": "left outer join uspc_current_mainclass_copy using(patent_id) left outer join uspc_current_copy using (patent_id, mainclass_id) left outer join location_uspc_mainclass on location.location_id=location_uspc_mainclass.location_id and uspc_current_mainclass_copy.mainclass_id=location_uspc_mainclass.mainclass_id left outer join uspc_mainclass on uspc_current_mainclass_copy.mainclass_id=uspc_mainclass.id left outer join uspc_subclass on uspc_current_copy.subclass_id=uspc_subclass.id"
 84 |   },
 85 |   {
 86 |     "entity_name": "cpc",
 87 |     "group_name": "cpcs",
 88 |     "keyId": "",
 89 |     "distinctCountId": "cpc_group_id",
 90 |     "join": "left outer join cpc_current_group_copy using(patent_id) left outer join cpc_group on cpc_current_group_copy.group_id=cpc_group.id left outer join cpc_current_copy using (patent_id, group_id) left outer join cpc_subsection on cpc_current_copy.subsection_id=cpc_subsection.id left outer join cpc_subgroup on cpc_current_copy.subgroup_id=cpc_subgroup.id left outer join location_cpc_group on location.location_id=location_cpc_group.location_id and cpc_group.id=location_cpc_group.group_id "
 91 |   },
 92 |   {
 93 |     "entity_name": "nber",
 94 |     "group_name": "nbers",
 95 |     "keyId": "",
 96 |     "distinctCountId": "nber_subcategory_id",
 97 |     "join": "left outer join nber_copy using(patent_id) left outer join location_nber_subcategory on location.location_id=location_nber_subcategory.location_id and nber_copy.subcategory_id=location_nber_subcategory.subcategory_id left outer join nber_subcategory on nber_copy.subcategory_id=nber_subcategory.id left outer join nber_category on nber_copy.category_id=nber_category.id"
 98 |   },
 99 |   {
100 |     "entity_name": "year",
101 |     "group_name": "years",
102 |     "keyId": "",
103 |     "distinctCountId": "year_id",
104 |     "join": "left outer join location_year on patent_inventor.location_id=location_year.location_id and patent.year=location_year.year"
105 |   },
106 |   {
107 |     "entity_name": "wipo",
108 |     "group_name": "wipos",
109 |     "keyId": "",
110 |     "distinctCountId": "wipo_field_id",
111 |     "join": "left outer join wipo on patent.patent_id=wipo.patent_id left outer join wipo_field on wipo.field_id=wipo_field.id"
112 |   },
113 |   {
114 |     "entity_name": "government_interest",
115 |     "group_name": "gov_interests",
116 |     "keyId": "",
117 |     "distinctCountId": "govint_patent_id",
118 |     "join": "left outer join government_interest on patent.patent_id=government_interest.patent_id left outer join patent_govintorg on patent.patent_id=patent_govintorg.patent_id left outer join patent_contractawardnumber on patent.patent_id=patent_contractawardnumber.patent_id left outer join government_organization on patent_govintorg.organization_id=government_organization.organization_id"
119 |   },
120 |   {
121 |     "entity_name": "lawyer",
122 |     "group_name": "lawyers",
123 |     "keyId": "",
124 |     "distinctCountId": "lawyer_id",
125 |     "join": "left outer join patent_lawyer ON patent_lawyer.patent_id=patent.patent_id left outer join lawyer on lawyer.lawyer_id=patent_lawyer.lawyer_id"
126 |   },
127 |   {
128 |     "entity_name": "examiner",
129 |     "group_name": "examiners",
130 |     "keyId": "",
131 |     "distinctCountId": "examiner_id",
132 |     "join": "left outer join patent_examiner on patent_examiner.patent_id=patent.patent_id left outer join examiner on examiner.examiner_id=patent_examiner.examiner_id"
133 |   },
134 |   {
135 |     "entity_name": "foreign_prior",
136 |     "group_name": "foreign_priority",
137 |     "keyId": "",
138 |     "distinctCountId": "foreign_doc_number",
139 |     "join": "left outer join foreignpriority on foreignpriority.patent_id=patent.patent_id"
140 |   },
141 |   {
142 |     "entity_name": "pct_dat",
143 |     "group_name": "pct_data",
144 |     "keyId": "",
145 |     "distinctCountId": "pct_id",
146 |     "join": "left outer join pctdata on pctdata.patent_id=patent.patent_id"
147 |   }
148 | ]


--------------------------------------------------------------------------------
/querymodule/app/specs/nber-entity-specs.json:
--------------------------------------------------------------------------------
  1 | [
  2 |   {
  3 |     "entity_name": "nber_subcategory",
  4 |     "group_name": "nber_subcategories",
  5 |     "keyId": "nber_subcategory_id",
  6 |     "distinctCountId": "nber_subcategory_id",
  7 |     "default_fields": [
  8 |       "nber_subcategory_id",
  9 |       "nber_subcategory_title"
 10 |     ],
 11 |     "join": "nber_subcategory left outer join nber_copy on nber_subcategory.id=nber_copy.subcategory_id left outer join nber_category on nber_copy.category_id=nber_category.id"
 12 |   },
 13 |   {
 14 |     "entity_name": "patent",
 15 |     "group_name": "patents",
 16 |     "keyId": "patent_id",
 17 |     "distinctCountId": "patent_id",
 18 |     "join": "left outer JOIN patent on nber_copy.patent_id=patent.patent_id"
 19 |   },
 20 |   {
 21 |     "entity_name": "assignee",
 22 |     "group_name": "assignees",
 23 |     "keyId": "assignee_key_id",
 24 |     "distinctCountId": "assignee_key_id",
 25 |     "join": "left outer join patent_assignee on nber_copy.patent_id=patent_assignee.patent_id left outer JOIN assignee on patent_assignee.assignee_id=assignee.assignee_id left outer join location as locationA on patent_assignee.location_id=locationA.location_id left outer join assignee_nber_subcategory on patent_assignee.assignee_id=assignee_nber_subcategory.assignee_id and nber_copy.subcategory_id=assignee_nber_subcategory.subcategory_id"
 26 |   },
 27 |   {
 28 |     "entity_name": "inventor",
 29 |     "group_name": "inventors",
 30 |     "keyId": "inventor_key_id",
 31 |     "distinctCountId": "inventor_key_id",
 32 |     "join": "left outer join patent_inventor on nber_copy.patent_id=patent_inventor.patent_id left outer join inventor ON patent_inventor.inventor_id=inventor.inventor_id left outer join location as locationI on patent_inventor.location_id=locationI.location_id left outer join inventor_nber_subcategory on patent_inventor.inventor_id=inventor_nber_subcategory.inventor_id and nber_copy.subcategory_id=inventor_nber_subcategory.subcategory_id"
 33 |   },
 34 |   {
 35 |     "entity_name": "rawinventor",
 36 |     "group_name": "rawinventors",
 37 |     "keyId": "rawinventor_key_id",
 38 |     "distinctCountId": "rawinventor_key_id",
 39 |     "join": "left outer join inventor_rawinventor on nber_copy.patent_id=inventor_rawinventor.patent_id"
 40 |   },
 41 |   {
 42 |     "entity_name": "application",
 43 |     "group_name": "applications",
 44 |     "keyId": "app_id",
 45 |     "distinctCountId": "app_id",
 46 |     "join": "left outer join application on nber_copy.patent_id=application.patent_id"
 47 |   },
 48 |   {
 49 |     "entity_name": "ipc",
 50 |     "group_name": "IPCs",
 51 |     "keyId": "",
 52 |     "distinctCountId": "ipc_class",
 53 |     "join": "left outer join ipcr on nber_copy.patent_id=ipcr.patent_id"
 54 |   },
 55 |   {
 56 |     "entity_name": "cpc",
 57 |     "group_name": "cpcs",
 58 |     "keyId": "",
 59 |     "distinctCountId": "cpc_group_id",
 60 |     "join": "left outer join cpc_current_group_copy on nber_copy.patent_id=cpc_current_group_copy.patent_id left outer join cpc_group on cpc_current_group_copy.group_id=cpc_group.id left outer join cpc_current_copy on cpc_current_group_copy.patent_id=cpc_current_copy.patent_id and cpc_group.id=cpc_current_copy.group_id  left outer join cpc_subsection on cpc_current_copy.subsection_id=cpc_subsection.id left outer join cpc_subgroup on cpc_current_copy.subgroup_id=cpc_subgroup.id"
 61 |   },
 62 |   {
 63 |     "entity_name": "uspc",
 64 |     "group_name": "uspcs",
 65 |     "keyId": "",
 66 |     "distinctCountId": "uspc_mainclass_id",
 67 |     "join": "left outer join uspc_current_mainclass_copy on nber_copy.patent_id=uspc_current_mainclass_copy.patent_id left outer join uspc_current_copy on uspc_current_mainclass_copy.patent_id=uspc_current_copy.patent_id and uspc_current_mainclass_copy.mainclass_id=uspc_current_copy.mainclass_id left outer join uspc_mainclass on uspc_current_mainclass_copy.mainclass_id=uspc_mainclass.id left outer join uspc_subclass on uspc_current_copy.subclass_id=uspc_subclass.id"
 68 |   },
 69 |   {
 70 |     "entity_name": "year",
 71 |     "group_name": "years",
 72 |     "keyId": "",
 73 |     "distinctCountId": "year_id",
 74 |     "join": "left outer JOIN patent as patent_year on nber_copy.patent_id=patent_year.patent_id left outer join nber_subcategory_patent_year on patent_year.year=nber_subcategory_patent_year.patent_year and nber_copy.subcategory_id=nber_subcategory_patent_year.subcategory_id"
 75 |   },
 76 |   {
 77 |     "entity_name": "wipo",
 78 |     "group_name": "wipos",
 79 |     "keyId": "",
 80 |     "distinctCountId": "wipo_field_id",
 81 |     "join": "left outer join wipo on nber_copy.patent_id=wipo.patent_id left outer join wipo_field on wipo.field_id=wipo_field.id"
 82 |   },
 83 |   {
 84 |     "entity_name": "government_interest",
 85 |     "group_name": "gov_interests",
 86 |     "keyId": "",
 87 |     "distinctCountId": "govint_patent_id",
 88 |     "join": "left outer join government_interest on nber_copy.patent_id=government_interest.patent_id left outer join patent_govintorg on nber_copy.patent_id=patent_govintorg.patent_id left outer join patent_contractawardnumber on nber_copy.patent_id=patent_contractawardnumber.patent_id left outer join government_organization on patent_govintorg.organization_id=government_organization.organization_id"
 89 |   },
 90 |   {
 91 |     "entity_name": "lawyer",
 92 |     "group_name": "lawyers",
 93 |     "keyId": "",
 94 |     "distinctCountId": "lawyer_id",
 95 |     "join": "left outer join patent_lawyer ON patent_lawyer.patent_id=nber_copy.patent_id left outer join lawyer on lawyer.lawyer_id=patent_lawyer.lawyer_id"
 96 |   },
 97 |   {
 98 |     "entity_name": "examiner",
 99 |     "group_name": "examiners",
100 |     "keyId": "",
101 |     "distinctCountId": "examiner_id",
102 |     "join": "left outer join patent_examiner on patent_examiner.patent_id=nber_copy.patent_id left outer join examiner on examiner.examiner_id=patent_examiner.examiner_id"
103 |   },
104 |   {
105 |     "entity_name": "foreign_prior",
106 |     "group_name": "foreign_priority",
107 |     "keyId": "",
108 |     "distinctCountId": "foreign_doc_number",
109 |     "join": "left outer join foreignpriority on foreignpriority.patent_id=nber_copy.patent_id"
110 |   },
111 |   {
112 |     "entity_name": "pct_dat",
113 |     "group_name": "pct_data",
114 |     "keyId": "",
115 |     "distinctCountId": "pct_id",
116 |     "join": "left outer join pctdata on pctdata.patent_id=nber_copy.patent_id"
117 |   }
118 | ]


--------------------------------------------------------------------------------
/querymodule/app/specs/patent-entity-specs.json:
--------------------------------------------------------------------------------
  1 | [
  2 |   {
  3 |     "entity_name": "patent",
  4 |     "group_name": "patents",
  5 |     "keyId": "patent_id",
  6 |     "distinctCountId": "patent_id",
  7 |     "default_fields": [
  8 |       "patent_id",
  9 |       "patent_number",
 10 |       "patent_title"
 11 |     ],
 12 |     "join": "patent"
 13 |   },
 14 |   {
 15 |     "entity_name": "inventor",
 16 |     "group_name": "inventors",
 17 |     "keyId": "inventor_key_id",
 18 |     "distinctCountId": "inventor_key_id",
 19 |     "join": "left outer JOIN patent_inventor ON patent.patent_id=patent_inventor.patent_id left outer JOIN inventor ON patent_inventor.inventor_id=inventor.inventor_id left outer join location as locationI on patent_inventor.location_id=locationI.location_id"
 20 |   },
 21 |   {
 22 |     "entity_name": "rawinventor",
 23 |     "group_name": "rawinventors",
 24 |     "keyId": "rawinventor_key_id",
 25 |     "distinctCountId": "rawinventor_key_id",
 26 |     "join": "left outer JOIN inventor_rawinventor on inventor_rawinventor.patent_id = patent.patent_id"
 27 |   },
 28 |   {
 29 |     "entity_name": "assignee",
 30 |     "group_name": "assignees",
 31 |     "keyId": "assignee_key_id",
 32 |     "distinctCountId": "assignee_key_id",
 33 |     "join": "left outer join patent_assignee on patent.patent_id=patent_assignee.patent_id left outer join assignee ON patent_assignee.assignee_id=assignee.assignee_id left outer join location as locationA on patent_assignee.location_id=locationA.location_id"
 34 |   },
 35 |   {
 36 |     "entity_name": "application",
 37 |     "group_name": "applications",
 38 |     "keyId": "app_id",
 39 |     "distinctCountId": "app_id",
 40 |     "join": "left outer join application on patent.patent_id=application.patent_id"
 41 |   },
 42 |   {
 43 |     "entity_name": "ipc",
 44 |     "group_name": "IPCs",
 45 |     "keyId": "",
 46 |     "distinctCountId": "ipc_class",
 47 |     "join": "left outer join ipcr on patent.patent_id=ipcr.patent_id"
 48 |   },
 49 |   {
 50 |     "entity_name": "application_citation",
 51 |     "group_name": "application_citations",
 52 |     "keyId": "",
 53 |     "distinctCountId": "appcit_app_number",
 54 |     "join": "left outer join usapplicationcitation on patent.patent_id=usapplicationcitation.citing_patent_id"
 55 |   },
 56 |   {
 57 |     "entity_name": "cited_patent",
 58 |     "group_name": "cited_patents",
 59 |     "keyId": "",
 60 |     "distinctCountId": "cited_patent_id",
 61 |     "join": "left outer join uspatentcitation as patentcit_fromciting_tocited on patent.patent_id=patentcit_fromciting_tocited.citing_patent_id left outer join patent as citedpatent on patentcit_fromciting_tocited.cited_patent_id=citedpatent.patent_id"
 62 |   },
 63 |   {
 64 |     "entity_name": "citedby_patent",
 65 |     "group_name": "citedby_patents",
 66 |     "keyId": "",
 67 |     "distinctCountId": "citedby_patent_id",
 68 |     "join": "left outer join uspatentcitation as patentcit_fromcited_tociting on patent.patent_id=patentcit_fromcited_tociting.cited_patent_id left outer join patent as citingpatent on patentcit_fromcited_tociting.citing_patent_id=citingpatent.patent_id"
 69 |   },
 70 |   {
 71 |     "entity_name": "uspc",
 72 |     "group_name": "uspcs",
 73 |     "keyId": "",
 74 |     "distinctCountId": "uspc_mainclass_id",
 75 |     "join": "left outer join uspc_current_mainclass_copy on patent.patent_id=uspc_current_mainclass_copy.patent_id left outer join uspc_current_copy on uspc_current_mainclass_copy.patent_id=uspc_current_copy.patent_id and uspc_current_mainclass_copy.mainclass_id=uspc_current_copy.mainclass_id left outer join uspc_mainclass on uspc_current_mainclass_copy.mainclass_id=uspc_mainclass.id left outer join uspc_subclass on uspc_current_copy.subclass_id=uspc_subclass.id"
 76 |   },
 77 |   {
 78 |     "entity_name": "cpc",
 79 |     "group_name": "cpcs",
 80 |     "keyId": "",
 81 |     "distinctCountId": "cpc_subsection_id",
 82 |     "join": "left outer join cpc_current_subsection_copy on patent.patent_id=cpc_current_subsection_copy.patent_id left outer join cpc_subsection on cpc_current_subsection_copy.subsection_id=cpc_subsection.id left outer join cpc_current_copy on cpc_current_subsection_copy.patent_id=cpc_current_copy.patent_id and cpc_subsection.id=cpc_current_copy.subsection_id left outer join cpc_group on cpc_current_copy.group_id=cpc_group.id left outer join cpc_subgroup on cpc_current_copy.subgroup_id=cpc_subgroup.id"
 83 |   },
 84 |   {
 85 |     "entity_name": "nber",
 86 |     "group_name": "nbers",
 87 |     "keyId": "",
 88 |     "distinctCountId": "nber_subcategory_id",
 89 |     "join": "left outer join nber_copy on patent.patent_id=nber_copy.patent_id left outer join nber_category on nber_copy.category_id=nber_category.id left outer join nber_subcategory on nber_copy.subcategory_id=nber_subcategory.id"
 90 |   },
 91 |   {
 92 |     "entity_name": "wipo",
 93 |     "group_name": "wipos",
 94 |     "keyId": "",
 95 |     "distinctCountId": "wipo_field_id",
 96 |     "join": "left outer join wipo on patent.patent_id=wipo.patent_id left outer join wipo_field on wipo.field_id=wipo_field.id"
 97 |   },
 98 |   {
 99 |     "entity_name": "government_interest",
100 |     "group_name": "gov_interests",
101 |     "keyId": "",
102 |     "distinctCountId": "govint_patent_id",
103 |     "join": "left outer join government_interest on patent.patent_id=government_interest.patent_id left outer join patent_govintorg on patent.patent_id=patent_govintorg.patent_id left outer join patent_contractawardnumber on patent.patent_id=patent_contractawardnumber.patent_id left outer join government_organization on patent_govintorg.organization_id=government_organization.organization_id"
104 |   },
105 |   {
106 |     "entity_name": "lawyer",
107 |     "group_name": "lawyers",
108 |     "keyId": "",
109 |     "distinctCountId": "lawyer_id",
110 |     "join": "left outer join patent_lawyer ON patent.patent_id=patent_lawyer.patent_id left outer join lawyer on lawyer.lawyer_id=patent_lawyer.lawyer_id"
111 |   },
112 |   {
113 |     "entity_name": "examiner",
114 |     "group_name": "examiners",
115 |     "keyId": "",
116 |     "distinctCountId": "examiner_id",
117 |     "join": "left outer join patent_examiner on patent_examiner.patent_id=patent.patent_id left outer join examiner on examiner.examiner_id=patent_examiner.examiner_id"
118 |   },
119 |   {
120 |     "entity_name": "foreign_prior",
121 |     "group_name": "foreign_priority",
122 |     "keyId": "",
123 |     "distinctCountId": "foreign_doc_number",
124 |     "join": "left outer join foreignpriority on foreignpriority.patent_id=patent.patent_id"
125 |   },
126 |   {
127 |     "entity_name": "pct_dat",
128 |     "group_name": "pct_data",
129 |     "keyId": "",
130 |     "distinctCountId": "pct_id",
131 |     "join": "left outer join pctdata on pctdata.patent_id=patent.patent_id"
132 |   }
133 | ]


--------------------------------------------------------------------------------
/querymodule/app/specs/uspc-entity-specs.json:
--------------------------------------------------------------------------------
  1 | [
  2 |   {
  3 |     "entity_name": "uspc_mainclass",
  4 |     "group_name": "uspc_mainclasses",
  5 |     "keyId": "uspc_mainclass_id",
  6 |     "distinctCountId": "uspc_mainclass_id",
  7 |     "default_fields": [
  8 |       "uspc_mainclass_id",
  9 |       "uspc_mainclass_title"
 10 |     ],
 11 |     "join": "uspc_current_mainclass_copy left outer join uspc_mainclass on uspc_current_mainclass_copy.mainclass_id=uspc_mainclass.id"
 12 |   },
 13 |   {
 14 |     "entity_name": "uspc_subclass",
 15 |     "group_name": "uspc_subclasses",
 16 |     "keyId": "uspc_subclass_id",
 17 |     "distinctCountId": "uspc_subclass_id",
 18 |     "join": "left outer join uspc_current_copy on uspc_current_mainclass_copy.patent_id=uspc_current_copy.patent_id and uspc_current_mainclass_copy.mainclass_id=uspc_current_copy.mainclass_id left outer join uspc_subclass on uspc_current_copy.subclass_id=uspc_subclass.id"
 19 |   },
 20 |   {
 21 |     "entity_name": "patent",
 22 |     "group_name": "patents",
 23 |     "keyId": "patent_id",
 24 |     "distinctCountId": "patent_id",
 25 |     "join": "left outer JOIN patent on uspc_current_mainclass_copy.patent_id=patent.patent_id"
 26 |   },
 27 |   {
 28 |     "entity_name": "assignee",
 29 |     "group_name": "assignees",
 30 |     "keyId": "assignee_key_id",
 31 |     "distinctCountId": "assignee_key_id",
 32 |     "join": "left outer join patent_assignee on uspc_current_mainclass_copy.patent_id=patent_assignee.patent_id left outer JOIN assignee on patent_assignee.assignee_id=assignee.assignee_id left outer join location as locationA on patent_assignee.location_id=locationA.location_id left outer join assignee_uspc_mainclass on uspc_current_mainclass_copy.mainclass_id=assignee_uspc_mainclass.mainclass_id and assignee.assignee_id=assignee_uspc_mainclass.assignee_id"
 33 |   },
 34 |   {
 35 |     "entity_name": "inventor",
 36 |     "group_name": "inventors",
 37 |     "keyId": "inventor_key_id",
 38 |     "distinctCountId": "inventor_key_id",
 39 |     "join": "left outer join patent_inventor on uspc_current_mainclass_copy.patent_id=patent_inventor.patent_id left outer join inventor ON patent_inventor.inventor_id=inventor.inventor_id left outer join location as locationI on patent_inventor.location_id=locationI.location_id left outer join inventor_uspc_mainclass on uspc_current_mainclass_copy.mainclass_id=inventor_uspc_mainclass.mainclass_id and inventor.inventor_id=inventor_uspc_mainclass.inventor_id"
 40 |   },
 41 |   {
 42 |     "entity_name": "rawinventor",
 43 |     "group_name": "rawinventors",
 44 |     "keyId": "rawinventor_key_id",
 45 |     "distinctCountId": "rawinventor_key_id",
 46 |     "join": "left outer join inventor_rawinventor on uspc_current_mainclass_copy.patent_id=inventor_rawinventor.patent_id"
 47 |   },
 48 |   {
 49 |     "entity_name": "application",
 50 |     "group_name": "applications",
 51 |     "keyId": "app_id",
 52 |     "distinctCountId": "app_id",
 53 |     "join": "left outer join application on uspc_current_mainclass_copy.patent_id=application.patent_id"
 54 |   },
 55 |   {
 56 |     "entity_name": "ipc",
 57 |     "group_name": "IPCs",
 58 |     "keyId": "",
 59 |     "distinctCountId": "ipc_class",
 60 |     "join": "left outer join ipcr on uspc_current_mainclass_copy.patent_id=ipcr.patent_id"
 61 |   },
 62 |   {
 63 |     "entity_name": "cpc",
 64 |     "group_name": "cpcs",
 65 |     "keyId": "",
 66 |     "distinctCountId": "cpc_group_id",
 67 |     "join": "left outer join cpc_current_group_copy on uspc_current_mainclass_copy.patent_id=cpc_current_group_copy.patent_id left outer join cpc_group on cpc_current_group_copy.group_id=cpc_group.id left outer join cpc_current_copy on cpc_current_group_copy.patent_id=cpc_current_copy.patent_id and cpc_group.id=cpc_current_copy.group_id left outer join cpc_subsection on cpc_current_copy.subsection_id=cpc_subsection.id left outer join cpc_subgroup on cpc_current_copy.subgroup_id=cpc_subgroup.id"
 68 |   },
 69 |   {
 70 |     "entity_name": "nber",
 71 |     "group_name": "nbers",
 72 |     "keyId": "",
 73 |     "distinctCountId": "nber_subcategory_id",
 74 |     "join": "left outer join nber_copy on uspc_current_mainclass_copy.patent_id=nber_copy.patent_id left outer join nber_category on nber_copy.category_id=nber_category.id left outer join nber_subcategory on nber_copy.subcategory_id=nber_subcategory.id"
 75 |   },
 76 |   {
 77 |     "entity_name": "year",
 78 |     "group_name": "years",
 79 |     "keyId": "",
 80 |     "distinctCountId": "year_id",
 81 |     "join": "left outer JOIN patent as patent_year on uspc_current_mainclass_copy.patent_id=patent_year.patent_id left outer join uspc_current_mainclass_patent_year on patent_year.year=uspc_current_mainclass_patent_year.patent_year and uspc_current_mainclass_copy.mainclass_id=uspc_current_mainclass_patent_year.mainclass_id"
 82 |   },
 83 |   {
 84 |     "entity_name": "wipo",
 85 |     "group_name": "wipos",
 86 |     "keyId": "",
 87 |     "distinctCountId": "wipo_field_id",
 88 |     "join": "left outer join wipo on uspc_current_mainclass_copy.patent_id=wipo.patent_id left outer join wipo_field on wipo.field_id=wipo_field.id"
 89 |   },
 90 |   {
 91 |     "entity_name": "government_interest",
 92 |     "group_name": "gov_interests",
 93 |     "keyId": "",
 94 |     "distinctCountId": "govint_patent_id",
 95 |     "join": "left outer join government_interest on uspc_current_mainclass_copy.patent_id=government_interest.patent_id left outer join patent_govintorg on uspc_current_mainclass_copy.patent_id=patent_govintorg.patent_id left outer join patent_contractawardnumber on uspc_current_mainclass_copy.patent_id=patent_contractawardnumber.patent_id left outer join government_organization on patent_govintorg.organization_id=government_organization.organization_id"
 96 |   },
 97 |   {
 98 |     "entity_name": "lawyer",
 99 |     "group_name": "lawyers",
100 |     "keyId": "",
101 |     "distinctCountId": "lawyer_id",
102 |     "join": "left outer join patent_lawyer ON patent_lawyer.patent_id=uspc_current_mainclass_copy.patent_id left outer join lawyer on lawyer.lawyer_id=patent_lawyer.lawyer_id"
103 |   },
104 |   {
105 |     "entity_name": "examiner",
106 |     "group_name": "examiners",
107 |     "keyId": "",
108 |     "distinctCountId": "examiner_id",
109 |     "join": "left outer join patent_examiner on patent_examiner.patent_id=uspc_current_mainclass_copy.patent_id left outer join examiner on examiner.examiner_id=patent_examiner.examiner_id"
110 |   },
111 |   {
112 |     "entity_name": "foreign_prior",
113 |     "group_name": "foreign_priority",
114 |     "keyId": "",
115 |     "distinctCountId": "foreign_doc_number",
116 |     "join": "left outer join foreignpriority on foreignpriority.patent_id=uspc_current_mainclass_copy.patent_id"
117 |   },
118 |   {
119 |     "entity_name": "pct_dat",
120 |     "group_name": "pct_data",
121 |     "keyId": "",
122 |     "distinctCountId": "pct_id",
123 |     "join": "left outer join pctdata on pctdata.patent_id=uspc_current_mainclass_copy.patent_id"
124 |   }
125 | ]


--------------------------------------------------------------------------------
/querymodule/composer.json:
--------------------------------------------------------------------------------
 1 | {
 2 |     "require": {
 3 |         "slim/slim": "^3.0",
 4 |         "monolog/monolog": "^2.9",
 5 |       "ext-pdo": "*"
 6 |     },
 7 |     "require-dev": {
 8 |         "phpunit/phpunit": "^11.0"
 9 |     }
10 | }
11 | 


--------------------------------------------------------------------------------
/querymodule/doc/API field lists.xlsx:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/PatentsView/PatentsView-API/86c2dd44cc0ac5b123d9b97bbad0f0efc6cf1992/querymodule/doc/API field lists.xlsx


--------------------------------------------------------------------------------
/querymodule/doc/PatentsView API Design and Technical Notes.md:
--------------------------------------------------------------------------------
  1 | #PatentsView API Design and Technical Notes
  2 | 
  3 | The PatentsView API (PV API) is written largely in PHP, makes use of the [Slim Framework](http://slimframework.com "Slim Framework") and log4php, and was developed for the Windows platform. Documentation for using the API can be found [here](http://54.88.226.197/api). Documentation for building and deploying the API can be found [here](https://github.com/CSSIP-AIR/PatentsView-API/wiki/API-Site-Setup-Instructions). This document will describe the general design and operation of the API, as well as some pertinent technical notes.
  4 | 
  5 | ##Source Code and Source Database
  6 | The code for the API is in [GitHub](https://github.com/CSSIP-AIR/PatentsView-API). It uses a database built using code found [here](https://github.com/CSSIP-AIR/PatentsView-DB), [here](https://github.com/CSSIP-AIR/PatentsProcessor), and [here](https://github.com/CSSIP-AIR/InventorDisambiguator) in GitHub, and uses data from the USPTO bulk granted patent and patent application files from USPTO and distributed by [Reed Technology](http://www.uspto.gov/products/catalog/index.jsp).
  7 | 
  8 | ##Source File Walkthrough
  9 | ###public_html Folder 
 10 | The `public_html` folder holds the files that are public-facing: currently
 11 | 
 12 | * `doc.html`
 13 | * `index.php`
 14 | * `web.config`.
 15 | 
 16 | ***index.php***
 17 | 
 18 | The entry into the API is `public_html\index.php`. This file registers and instantiates the Slim framework and passes execution to `app\routes\query.php`, which contains the Slim route definitions and handlers.
 19 | 
 20 | ***doc.html***
 21 | 
 22 | Created from `doc\doc.md` by using `doc\make_doc.py`, this provides documentation for API users.
 23 | 
 24 | ***web.config***
 25 | 
 26 | This is the standard IIS web.config file, and contains the basic configuration settings for the API web site.
 27 | 
 28 | ###doc Folder
 29 | Contains the documentation (`doc.md`) for API users, in Markdown format, and a Python script (`make_doc.py`) for converting `doc.md` to HTML.
 30 | 
 31 | ###DBScripts Folder
 32 | 
 33 | This folder contains MySQL scripts to create the schema objects for the PVSupport database.
 34 | 
 35 | ###logs Folder
 36 | 
 37 | No code files are actually put into this folder, but it needs to exist so that when the running code attempts to create log files it succeeds.
 38 | 
 39 | ###tests Folder
 40 | 
 41 | Contains the unit tests for the API. Note that some of these unit tests are data dependent: if the data in the database change, then it is possible some of the unit tests will fail.
 42 | 
 43 | ###app Folder
 44 | 
 45 | This folder contains the bulk of the code for the API.
 46 | 
 47 | ***routes\query.php***
 48 | 
 49 | This file contains the Slim framework routes. It defines the routes available for GET and POST, and has some basic validation of the parameters (e.g. to make sure they are valid JSON format).
 50 | 
 51 | It also encodes the results into JSON or XML prior to returning them in the response object.
 52 | 
 53 | You will need to edit this file to add a new routes for a new or existing primary entity.
 54 | 
 55 | ***entitySpecs.php***
 56 | 
 57 | `entitySpecs.php` contains the metadata used by the API to map API fields to the MySQL database.
 58 | 
 59 | You will see that there are two metadata structures for each primary entity. Primary entities are: patents, inventors, assignees, cpc subsections, uspc mainclasses, and locations; these correspond 1-to-1 with the API primary routes. There is one metadata structure called `*_ENTITY_SPECS` and one called `*_FIELD_SPECS`.
 60 | 
 61 | **`*_ENTITY_SPECS`** has an entry for the primary entity and one for each subentity; the one for the primary entity must be listed first. These define the name of the entity, what field is used for the key for the entity, and the SQL join statement for the entity. More details about the use of these are in the code.
 62 | 
 63 | **`*_FIELD_SPECS`** has an entry for each field that is available in any part of the API for this primary entity, the SQL expression to obtain the value for the field, and flags that dictate the use of the field.
 64 | 
 65 | This should be the only file that you need to change when adding or modifying fields or subentities. All the rest of the code uses this metadata when building SQL statements and formatting the API results. You will also modify this file when adding whole new primary entities, as well as adding new Slim routes in `routes\query.php`. 
 66 | 
 67 | ***executeQuery.php***
 68 | 
 69 | `executeQuery.php` contains the `executeQuery` function, which orchestrates the parsing of the API call into the querying of the database and taking those results and putting them into nested PHP arrays. There is not much code in this file - it simply provides order to those steps and a little glue between them.
 70 | 
 71 | ***QueryParser.php***
 72 | 
 73 | `QueryParser.php` contains the class that performs the parsing of the API call query parameters into the needed data structures to perform the querying. Primarily it will build a SQL *where* clause from query parameters, while also recording which fields are referenced in that clause. It performs many error checks to ensure that the fields specified in the query parameters are valid for the query operation and that the syntax of the query parameter is correct. The end result is a string that contains the *where* clause and a list of fields used in that clause.
 74 | 
 75 | This file should be the only one to change in order to define new query operators; e.g. if a *between* operator is desired in the future.
 76 | 
 77 | Be sure to reference the API documentation in the `doc\doc.md` file to ensure that the code in this file is in sync  with the syntax in the documentation.
 78 | 
 79 | ***DatabaseQuery.php***
 80 | 
 81 | `DatabaseQuery.php` contains the class that executes the database statements in order to obtain the results for the specified query.
 82 | 
 83 | The general model for querying the database is:
 84 | 
 85 | * Check to see if the query has been run before and its results cached in the PV support database.
 86 |   * If not, then build and execute an *insert select* statement that will insert into the PV support dastabase the primary entity IDs that meet the query criteria.
 87 | * Build and execute *select* statements to get one page of results. There will be a *select* issued for the primary entity and one each for the subentities. They will use the cached results in the PV support database (which are ordered primary entity IDs) so that the expensive *where* clause does not have to be issued repeatedly.
 88 | * The results will be an array of arrays, with one root array for each entity-type, and the subarrays containing the individual entities.    
 89 | 
 90 | ***convertDBResultsToNestedStructure.php***
 91 | 
 92 | `convertDBResultsToNestedStructure.php` contains the function to convert the DB results into the structure for returning from the API. The input is an array of arrays, where there is one root array for each entity type involved in the results, and within that an array of entity data objects. The output will be an array of primary entities, and within each primary entity will be its fields and an array of subentities with their fields.
 93 | 
 94 | The code in this is rather tight in order to get better performance. It also relies heavily on PHP *dynamic variables*, aka *variable variables*. This makes the code tougher to read; but without that there would be multiple blocks of essentially the same code, with the only difference being variable names, and thus would be harder to maintain and keep each block consistent. When debugging, you can add watch variables to see the contents of these dynamic variables.   
 95 | 
 96 | ***ErrorHandler.php***
 97 | 
 98 | Basic logging of errors and setting the HTTP response object with status codes and messages. Uses *log4php*.
 99 | 
100 | ***config-sample.php***
101 | 
102 | Configuration settings for the API for defining the MySQL connection parameters and API limits.
103 | 
104 | Note that the API actually looks for and uses the file `config.php`. That file is not and should not be checked into GitHub. The reason for that is to avoid putting database credentials into a public code repository. So on operating environments, this file (`config-sample.php`) would need to be copied to `config.php`, and then change the settings in `config.php` to match that operating environment. 
105 | 
106 | ##Technical Notes
107 | 
108 | * Cached results
109 |   * The first time a query is run, its results are cached in the PV support database. The results will be the primary entities primary key and the sequence of those IDs to correspond to the sort order specified in the API.
110 |   * A CRC32 hash is used to determine if the query has been run before. That hash uses the primary entity field name, the query parameter, and the sort parameter.
111 |   * Subsequent requests of the same query will use the cached results. This provides significant performance improvement for repeated queries, as in the case when paging through results, since the most expensive part (determining the result set) is only run once.
112 |   * This cache must be cleared out when:
113 |     * The PV database is updated with new or modified data.
114 |     * The API is updated to a new version.
115 |     * At a regular interval to keep it from growing too large.
116 |       * This interval is TBD and depends on the growth rate, the storage space available on the DB server, and the performance of inserting into the cache tables.
117 |       * An alternative to completely clearing the cache results is to use a sliding window based on either date or total number of cached results.  
118 | * Only one level of entity hierarchy
119 |   * The design model for this whole API is based on the limitation that the results from the API will only have one-level of hierarchy of subentities under the primary entity. For e.g., if patents are the primary entity and inventors are a subentity, the inventor subentity cannot also have subentities (like locations). If that model needs to be changed, then much of the API code will need to be changed as well.
120 |   * Part of the reason for choosing this model was the requirement by USPTO that the API results, when formatted as XML, could be imported directly into an Excel spreadsheet. While Excel can handle multiple levels in the XML hierarchy, it begins to get very difficult to understand and make use of the data in Excel.  
121 | 
122 | 


--------------------------------------------------------------------------------
/querymodule/doc/_page.html:
--------------------------------------------------------------------------------
  1 | <!DOCTYPE html>
  2 | <html lang="en">
  3 |   <head>
  4 |     <meta charset="utf-8" />
  5 |     <meta http-equiv="X-UA-Compatible" content="IE=edge" />
  6 |     <meta name="viewport" content="width=device-width, initial-scale=1" />
  7 |     <title>PatentsView Query Modle API</title>
  8 |     <link
  9 |       rel="stylesheet"
 10 |       href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.2/css/bootstrap.min.css"
 11 |     />
 12 |     <link
 13 |       rel="stylesheet"
 14 |       href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.2/css/bootstrap-theme.min.css"
 15 |     />
 16 |     <link
 17 |       href="http://maxcdn.bootstrapcdn.com/font-awesome/4.2.0/css/font-awesome.min.css"
 18 |       rel="stylesheet"
 19 |     />
 20 |     <link rel="stylesheet" href="css/custom.css" />
 21 |   <!-- Global site tag (gtag.js) - Google Analytics -->
 22 |     <script
 23 |       async
 24 |       src="https://www.googletagmanager.com/gtag/js?id=UA-3509031-17"
 25 |     ></script>
 26 |     <script>
 27 |       window.dataLayer = window.dataLayer || [];
 28 |       function gtag() {
 29 |         dataLayer.push(arguments);
 30 |       }
 31 |       gtag("js", new Date());
 32 | 
 33 |       gtag("config", "UA-3509031-17");
 34 |     </script>
 35 | </head>
 36 |   <body role="document">
 37 |     <nav class="navbar navbar-inverse navbar-fixed-top">
 38 |       <div class="container">
 39 |         <div class="navbar-header"></div>
 40 |         <div id="navbar" class="navbar-collapse collapse">
 41 |           <ul class="nav navbar-nav">
 42 |             <li class="logo">
 43 |               <a href="doc.html" title="PatentsView - USPTO"
 44 |                 ><img alt="PatentsView Logo" src="img/logo.png"
 45 |               /></a>
 46 |             </li>
 47 |           </ul>
 48 |         </div>
 49 |       </div>
 50 |     </nav>
 51 | 
 52 |     <div class="container" role="main">
 53 |       <div class="col-md-3">
 54 |         <ul class="list-group" id="contents">
 55 |           <li
 56 |             class="list-group-item {% block introduction_section_class %}{% endblock %}"
 57 |           >
 58 |             <p class="section-name"><a href="doc.html">Introduction</a></p>
 59 |             <ul class="section-list">
 60 |               <li><a href="doc.html#overview">PatentsView Overview</a></li>
 61 |               <li><a href="doc.html#database_schema">Database Schema</a></li>
 62 |               <li>
 63 |                 <a href="doc.html#inventor_disambiguation"
 64 |                   >Inventor Disambiguation</a
 65 |                 >
 66 |               </li>
 67 |               <li>
 68 |                 <a href="doc.html#patent_classes_and_technologies"
 69 |                   >Patent Classes and Technologies</a
 70 |                 >
 71 |               </li>
 72 |               <li><a href="doc.html#glossary">Glossary of Key Terms</a></li>
 73 |               <li><a href="doc.html#copyright_notice">Copyright Notice</a></li>
 74 |             </ul>
 75 |           </li>
 76 |           <li
 77 |             class="list-group-item {% block query_language_section_class %}{% endblock %}"
 78 |           >
 79 |             <p class="section-name">
 80 |               <a href="query_language.html">Query Language</a>
 81 |             </p>
 82 |             <ul class="section-list">
 83 |               <li>
 84 |                 <a href="query_language.html#query_string_format"
 85 |                   >Query String Format</a
 86 |                 >
 87 |               </li>
 88 |               <li>
 89 |                 <a href="query_language.html#field_list_format"
 90 |                   >Field List Format</a
 91 |                 >
 92 |               </li>
 93 |               <li>
 94 |                 <a href="query_language.html#options_parameter"
 95 |                   >Options Parameter</a
 96 |                 >
 97 |               </li>
 98 |               <li>
 99 |                 <a href="query_language.html#sort_parameter">Sort Parameter</a>
100 |               </li>
101 |               <li>
102 |                 <a href="query_language.html#results_format">Results Format</a>
103 |               </li>
104 |               <li>
105 |                 <a href="query_language.html#response_status_codes"
106 |                   >Response Status Codes</a
107 |                 >
108 |               </li>
109 |             </ul>
110 |           </li>
111 |           <li
112 |             class="list-group-item {% block patent_section_class %}{% endblock %}"
113 |           >
114 |             <p class="section-name"><a href="patent.html">Patents Query</a></p>
115 |             <ul class="section-list">
116 |               <li><a href="patent.html#field_list">Patent Field List</a></li>
117 |             </ul>
118 |           </li>
119 |           <li
120 |             class="list-group-item {% block inventor_section_class %}{% endblock %}"
121 |           >
122 |             <p class="section-name">
123 |               <a href="inventor.html">Inventors Query</a>
124 |             </p>
125 |             <ul class="section-list">
126 |               <li>
127 |                 <a href="inventor.html#field_list">Inventor Field List</a>
128 |               </li>
129 |             </ul>
130 |           </li>
131 |           <li
132 |             class="list-group-item {% block assignee_section_class %}{% endblock %}"
133 |           >
134 |             <p class="section-name">
135 |               <a href="assignee.html">Assignees Query</a>
136 |             </p>
137 |             <ul class="section-list">
138 |               <li>
139 |                 <a href="assignee.html#field_list">Assignee Field List</a>
140 |               </li>
141 |             </ul>
142 |           </li>
143 |           <li
144 |             class="list-group-item {% block location_section_class %}{% endblock %}"
145 |           >
146 |             <p class="section-name">
147 |               <a href="location.html">Locations Query</a>
148 |             </p>
149 |             <ul class="section-list">
150 |               <li>
151 |                 <a href="location.html#field_list">Location Field List</a>
152 |               </li>
153 |             </ul>
154 |           </li>
155 |           <li
156 |             class="list-group-item {% block cpc_subsection_section_class %}{% endblock %}"
157 |           >
158 |             <p class="section-name">
159 |               <a href="cpc_subsection.html">CPC Subsections Query</a>
160 |             </p>
161 |             <ul class="section-list">
162 |               <li>
163 |                 <a href="cpc_subsection.html#field_list"
164 |                   >CPC Subsection Field List</a
165 |                 >
166 |               </li>
167 |             </ul>
168 |           </li>
169 |           <li
170 |             class="list-group-item {% block uspc_section_class %}{% endblock %}"
171 |           >
172 |             <p class="section-name">
173 |               <a href="uspc.html">USPC Mainclasses Query</a>
174 |             </p>
175 |             <ul class="section-list">
176 |               <li>
177 |                 <a href="uspc.html#field_list">USPC Mainclass Field List</a>
178 |               </li>
179 |             </ul>
180 |           </li>
181 |           <li
182 |             class="list-group-item {% block nber_subcat_section_class %}{% endblock %}"
183 |           >
184 |             <p class="section-name">
185 |               <a href="nber_subcat.html">NBER Subcategories Query</a>
186 |             </p>
187 |             <ul class="section-list">
188 |               <li>
189 |                 <a href="nber_subcat.html#field_list"
190 |                   >NBER Subcategory Field List</a
191 |                 >
192 |               </li>
193 |             </ul>
194 |           </li>
195 |         </ul>
196 |       </div>
197 |       <div class="col-md-9">
198 |         <div id="documentation">
199 |           {% block body %}{% endblock %}
200 |         </div>
201 |       </div>
202 |     </div>
203 | 
204 |     <script src="https://ajax.googleapis.com/ajax/libs/jquery/1.11.2/jquery.min.js"></script>
205 |     <script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.2/js/bootstrap.min.js"></script>
206 | 
207 |     {% block page_script %}{% endblock %}
208 |   </body>
209 | </html>
210 | 


--------------------------------------------------------------------------------
/querymodule/doc/_section.html:
--------------------------------------------------------------------------------
 1 | {% extends "_page.html" %}
 2 | 
 3 | {% block body %}
 4 | 
 5 | <h1>{% block section_title_plural %}{% endblock %} Query</h1>
 6 | 
 7 | <p class="code">
 8 |     <strong>GET</strong> {% block section_get_url %}{% endblock %}<br/>
 9 |     <strong>POST</strong> {% block section_post_url %}{% endblock %}
10 | </p>
11 | 
12 | {% block section_introduction %}{% endblock %}
13 | 
14 | <p>The HTTP GET request method is the preferred access mechanism; however when the query parameters exceed a reasonable size (around 2,000 characters), then the POST method can be used. When using the POST method, the query parameters should be embedded within a JSON string within the request body.</p>
15 | 
16 | <table class="table table-striped documentation-parameters">
17 |     <thead>
18 |         <tr>
19 |             <th class="col-md-1">Name</th>
20 |             <th class="col-md-6">Description</th>
21 |             <th class="col-md-5">Details</th>
22 |         </tr>
23 |     </thead>
24 |     <tbody>
25 |         <tr>
26 |             <td class="code">q</td>
27 |             <td>JSON formatted object containing the query parameters. See below for details on formatting this object.</td>
28 |             <td>string, required <br/> <strong>example:</strong> <span class="code">{% block section_query_example %}{% endblock %}</span></td>
29 |         </tr>
30 |         <tr>
31 |             <td class="code">f</td>
32 |             <td>JSON formatted array of fields to include in the results. If not provided, defaults to {% block section_field_defaults %}{% endblock %}.</td>
33 |             <td>string, optional <br/> <strong>example:</strong> <span class="code">{% block section_field_example %}{% endblock %}</span></td>
34 |         </tr>
35 |         <tr>
36 |             <td class="code">s</td>
37 |             <td>JSON formatted array of objects to sort the results. If not provided, defaults to <span class="code">{% block section_sort_default %}{% endblock %}</span>.</td>
38 |             <td>string, optional <br/> <strong>example:</strong> <span class="code">{% block section_sort_example %}{% endblock %}</span></td>
39 |         </tr>
40 |         <tr>
41 |             <td class="code">o</td>
42 |             <td>
43 |                 <p>JSON formatted object of options to modify the query or results. Available options are:</p>
44 |                 <p><span class="code">matched_subentities_only</span> &mdash; Only subentity data that matches the subentity specific criteria is included in results. Defaults to true.</p>
45 |                 <p><span class="code">include_subentity_total_counts</span> &mdash; Total counts of unique subentities included in results. Defaults to false.</p>
46 |                 <p><span class="code">page</span> &mdash; return only the Nth page of results. Defaults to 1.</p>
47 |                 <p><span class="code">per_page</span> &mdash; Size of each page of results. Defaults to 25.</p>
48 |             </td>
49 |             <td>string, optional <br/> <strong>example:</strong> <span class="code">o={"matched_subentities_only": "true", "page": 2, "per_page": 50, "include_subentity_total_counts": "false"}</span></td>
50 |         </tr>
51 |         <tr>
52 |             <td class="code">format</td>
53 |             <td>
54 |                 <p>Specifies the response data format. If not provided, defaults to JSON. Available options are:</p>
55 |                 <p><span class="code">json</span></p>
56 |                 <p><span class="code">xml</span></p>
57 |             </td>
58 |             <td>string, optional <br/> <strong>example:</strong> <span class="code">format=xml</span></td>
59 |         </tr>
60 |     </tbody>
61 | </table>
62 | 
63 | <p>An example of a complete API call using the GET verb is:</p>
64 | 
65 | <p class="well code"><a href='{{ base_url }}{{ self.section_get_url_example() | trim }}'>{{ base_url }}{% block section_get_url_example %}{% endblock %}</a></p>
66 | 
67 | <p>An example of the equivalent API call using the POST verb is:</p>
68 | 
69 | <p class="well code">{{ base_url }}{% block section_post_url_example %}{% endblock %}</p>
70 | 
71 | <p>with the body containing:</p>
72 | 
73 | <p class="well code">{% block section_post_body_example %}{% endblock %}</p>
74 | 
75 | <h2><a class="anchor"></a>Examples</h2>
76 | 
77 | {% block section_examples %}{% endblock %}
78 | 
79 | <h2><a class="anchor" name="field_list"></a>{{ self.section_title() }} Field List</h2>
80 | 
81 | <table class="table table-striped documentation-fieldlist">
82 |     <tr>
83 |         {% for name in field_list_column_names %}
84 |         <th>{{name}}</th>
85 |         {% endfor %}
86 |     </tr>
87 | 
88 |     {% for field in field_list %}
89 |     <tr>
90 |         {% for name in field_list_column_names %}
91 |         <td>{{ field[name] }}</td>
92 |         {% endfor %}
93 |     </tr>
94 |     {% endfor %}
95 | </table>
96 | 
97 | {% endblock %}
98 | 


--------------------------------------------------------------------------------
/querymodule/doc/assignee.html:
--------------------------------------------------------------------------------
 1 | {% extends "_section.html" %}
 2 | 
 3 | {% block assignee_section_class %}section-selected{% endblock %}
 4 | 
 5 | {% block section_title %}Assignee{% endblock %}
 6 | {% block section_title_plural %}Assignees{% endblock %}
 7 | 
 8 | {% block section_get_url %}/api/assignees/query?q{,f,o,s}{% endblock %}
 9 | {% block section_post_url %}/api/assignees/query{% endblock %}
10 | 
11 | {% block section_introduction %}
12 | <p>This will search for assignees matching the query string (<span class="code">q</span>) and returning the data fields listed in the field string (<span class="code">f</span>) sorted by the fields in the sort string (<span class="code">s</span>) using options provided in the option string (<span class="code">o</span>).</p>
13 | {% endblock %}
14 | 
15 | {% block section_query_example %}
16 | {"inventor_last_name": "Whitney"}
17 | {% endblock %}
18 | 
19 | {% block section_field_defaults %}
20 | <span class="code">assignee_id</span>, <span class="code">assignee_first_name</span>, <span class="code">assignee_last_name</span>, and <span class="code">assignee_organization</span>
21 | {% endblock %}
22 | 
23 | {% block section_field_example %}
24 | ["patent_number", "date"]
25 | {% endblock %}
26 | 
27 | {% block section_sort_default %}
28 | assignee_key_id
29 | {% endblock %}
30 | 
31 | {% block section_sort_example %}
32 | [{"assignee_organization":"desc"}]
33 | {% endblock %}
34 | 
35 | {% block section_get_url_example %}
36 | assignees/query?q={"_begins":{"assignee_organization":"Race"}}&amp;f=["patent_number","patent_date","assignee_organization","assignee_id"]
37 | {% endblock %}
38 | 
39 | {% block section_post_url_example %}
40 | assignees/query
41 | {% endblock %}
42 | 
43 | {% block section_post_body_example %}
44 | {"q":{"_begins":{"assignee_organization":"Race"}},"f":["patent_number","patent_date","assignee_organization","assignee_id"]}
45 | {% endblock %}
46 | 
47 | 
48 | {% block section_examples %}
49 | <ul>
50 |     <li>
51 |         <p>Return the default fields for assignees on patents with a patent type of "utility", granted between 1999 and 2001, and whose title contains the word "Software".</p>
52 |         <p class="well code"><a href='{{ base_url }}assignees/query?q={"_and":[{"patent_type":"utility"},{"_text_any":{"patent_title":"Software"}}, {"_gte":{"patent_date":"1999-01-01"}},{"_lte":{"patent_date":"2001-12-31"}}]}'>{{ base_url }}assignees/query?q={"_and":[{"patent_type":"utility"},{"_text_any":{"patent_title":"Software"}}, {"_gte":{"patent_date":"1999-01-01"}},{"_lte":{"patent_date":"2001-12-31"}}]}</a></p> 
53 |     </li>
54 |     <li>
55 |         <p>Return the assignee types of all patents in NBER subcategory 22.</p>
56 |         <p class="well code"><a href='{{ base_url }}assignees/query?q={"_eq":{"nber_subcategory_id":"22"}}&f=["assignee_type"]'>{{ base_url }}assignees/query?q={"nber_subcategory_id":"22"}&f=["assignee_type"]</a></p>
57 |     </li>
58 | </ul>
59 | {% endblock %}
60 | 


--------------------------------------------------------------------------------
/querymodule/doc/cpc_subsection.html:
--------------------------------------------------------------------------------
 1 | {% extends "_section.html" %}
 2 | 
 3 | {% block cpc_subsection_section_class %}section-selected{% endblock %}
 4 | 
 5 | {% block section_title %}CPC Subsection{% endblock %}
 6 | {% block section_title_plural %}CPC Subsections{% endblock %}
 7 | 
 8 | {% block section_get_url %}/api/cpc_subsections/query?q{,f,o,s}{% endblock %}
 9 | {% block section_post_url %}/api/cpc_subsections/query{% endblock %}
10 | 
11 | {% block section_introduction %}
12 | <p>This will search for CPC (Cooperative Patent Classification) subsections matching the query string (<span class="code">q</span>) and returning the data fields listed in the field string (<span class="code">f</span>) sorted by the fields in the sort string (<span class="code">s</span>) using options provided in the option string (<span class="code">o</span>).</p>
13 | {% endblock %}
14 | 
15 | {% block section_query_example %}
16 | {"cpc_subsection_id":"G12"}
17 | {% endblock %}
18 | 
19 | {% block section_field_defaults %}
20 | <span class="code">cpc_subsection_id</span> and <span class="code">cpc_subsection_title</span>
21 | {% endblock %}
22 | 
23 | {% block section_field_example %}
24 | ["cpc_subsection_id", "cpc_subsection_title","cpc_total_num_patents"]
25 | {% endblock %}
26 | 
27 | {% block section_sort_default %}
28 | cpc_subsection_id
29 | {% endblock %}
30 | 
31 | {% block section_sort_example %}
32 | [{"cpc_total_num_patents":"desc"}]
33 | {% endblock %}
34 | 
35 | {% block section_get_url_example %}
36 | cpc_subsections/query?q={"cpc_subsection_id":"G12"}&f=["cpc_subsection_id","cpc_subsection_title","cpc_total_num_patents"]
37 | {% endblock %}
38 | 
39 | {% block section_post_url_example %}
40 | cpc_subsections/query
41 | {% endblock %}
42 | 
43 | {% block section_post_body_example %}
44 | {"q":{"cpc_subsection_id":"G12"},"f":["cpc_subsection_id", "cpc_subsection_title","cpc_total_num_patents"]}
45 | {% endblock %}
46 | 
47 | {% block section_examples %}
48 | <ul>
49 |     <li>
50 |     <p>Return the total number of inventors within CPC subsection F41 "Weapons".</p>
51 |     <p class="well code"><a href='{{ base_url }}cpc_subsections/query?q={"cpc_subsection_id":"F41"}&f=["cpc_total_num_inventors"]'>{{ base_url }}cpc_subsections/query?q={"cpc_subsection_id":"F41"}&f=["cpc_total_num_inventors"]</a></p>
52 |     </li>
53 |     <li>
54 |     <p>Return the last known location for assignees with patents in CPC subsection H02 "Generation; Conversion or Distribution of Electric Power".</p>
55 |     <p class="well code"><a href='{{ base_url }}cpc_subsections/query?q={"cpc_subsection_id":"H02"}&f=["assignee_lastknown_city","assignee_lastknown_state","assignee_lastknown_country"]'>{{ base_url }}cpc_subsections/query?q={"cpc_subsection_id":"H02"}&f=["assignee_lastknown_city","assignee_lastknown_state","assignee_lastknown_country"]</a></p>
56 |     </li>
57 | </ul>
58 | {% endblock %}
59 | 


--------------------------------------------------------------------------------
/querymodule/doc/css/custom.css:
--------------------------------------------------------------------------------
 1 | body {
 2 |     padding-top: 80px;
 3 | }
 4 | 
 5 | a.anchor {
 6 |     display: block;
 7 |     position: relative;
 8 |     top: -75px;
 9 |     visibility: hidden;
10 | }
11 | 
12 | .navbar {
13 |     background-image: linear-gradient(#54677B, #48596A);
14 | }
15 | 
16 | .navbar-inverse .navbar-nav > .active > a {
17 |     background-image: none;
18 |     background-color: transparent;
19 | }
20 | 
21 | #contents {
22 |     position: fixed;
23 | }
24 | 
25 | #contents .section-list {
26 |     display: none;
27 | }
28 | 
29 | #contents li.section-selected {
30 |     background-color: #EEEEEE;
31 | }
32 | 
33 | #contents li.section-selected .section-list {
34 |     display: inherit;
35 | }
36 | 
37 | #contents p.section-name {
38 |     font-weight: bold;
39 | }
40 | 
41 | #contents ul.section-list {
42 |     list-style-type: none;
43 |     padding: 0 10px;
44 |     margin: 0;
45 | }
46 | 
47 | #documentation .code {
48 |     font-family: monospace;
49 | }
50 | 
51 | #documentation .documentation-parameters {
52 |     font-size: 12px;
53 | }
54 | 
55 | #documentation .documentation-fieldlist {
56 |     font-size: 12px;
57 | }
58 | 
59 | #diagram {
60 |     border: dashed 2px lightgray;
61 | }
62 | 
63 | #diagram svg {
64 |     display: inline;
65 |     width: 100%;
66 |     min-width: inherit;
67 |     max-width: 100%;
68 |     height: 700px;
69 |     min-height: inherit;
70 |     max-height: 900px;
71 | }
72 | 


--------------------------------------------------------------------------------
/querymodule/doc/img/logo.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/PatentsView/PatentsView-API/86c2dd44cc0ac5b123d9b97bbad0f0efc6cf1992/querymodule/doc/img/logo.png


--------------------------------------------------------------------------------
/querymodule/doc/inventor.html:
--------------------------------------------------------------------------------
 1 | {% extends "_section.html" %}
 2 | 
 3 | {% block inventor_section_class %}section-selected{% endblock %}
 4 | 
 5 | {% block section_title %}Inventor{% endblock %}
 6 | {% block section_title_plural %}Inventors{% endblock %}
 7 | 
 8 | {% block section_get_url %}/api/inventors/query?q{,f,o,s}{% endblock %}
 9 | {% block section_post_url %}/api/inventors/query{% endblock %}
10 | 
11 | {% block section_introduction %}
12 | <p>This will search for inventors matching the query string (<span class="code">q</span>) and returning the data fields listed in the field string (<span class="code">f</span>) sorted by the fields in the sort string (<span class="code">s</span>) using options provided in the option string (<span class="code">o</span>).</p>
13 | {% endblock %}
14 | 
15 | {% block section_query_example %}
16 | {"inventor_last_name": "Whitney"}
17 | {% endblock %}
18 | 
19 | {% block section_field_defaults %}
20 | <span class="code">inventor_id</span>, <span class="code">inventor_first_name</span>, and <span class="code">inventor_last_name</span>
21 | {% endblock %}
22 | 
23 | {% block section_field_example %}
24 | ["patent_number", "date"]
25 | {% endblock %}
26 | 
27 | {% block section_sort_default %}
28 | inventor_key_id
29 | {% endblock %}
30 | 
31 | {% block section_sort_example %}
32 | [{"inventor_last_name":"desc"}]
33 | {% endblock %}
34 | 
35 | {% block section_get_url_example %}
36 | inventors/query?q={"inventor_last_name":"Young"}&f=["inventor_id","inventor_last_name","inventor_first_name","patent_number","patent_date"]
37 | {% endblock %}
38 | 
39 | {% block section_post_url_example %}
40 | inventors/query
41 | {% endblock %}
42 | 
43 | {% block section_post_body_example %}
44 | {"q":{"inventor_last_name":"Young"},"f":["inventor_id","inventor_last_name","inventor_first_name","patent_number","patent_date"]}
45 | {% endblock %}
46 | 
47 | {% block section_examples %}
48 | <ul>
49 |     <li>
50 |         <p>Return the first name, last name, and associated patent title of all inventors who had patents granted between 2000 and 2006 where the patent title contains the word "bicycle".</p>
51 |         <p class="well code"><a href='{{ base_url}}inventors/query?q={"_and":[{"_gte":{"patent_date":"2000-01-01"}},{"_lt":{"patent_date":"2007-01-01"}},{"_text_any":{"patent_title":"bicycle"}}]}&f=["inventor_first_name","inventor_last_name"]'>{{ base_url }}inventors/query?q={"_and":[{"_gte":{"patent_date":"2000-01-01"}},{"_lt":{"patent_date":"2007-01-01"}},{"_text_any":{"patent_title":"bicycle"}}]}&f=["inventor_first_name","inventor_last_name"]</a></p>
52 |     </li>
53 |     <li>
54 |         <p>Return the last known location of inventors with patents in NBER subcategory 25.</p>
55 |         <p class="well code"><a href='{{ base_url }}inventors/query?q={"nber_subcategory_id":25}&f=["inventor_lastknown_city","inventor_lastknown_state"]'>{{ base_url }}inventors/query?q={"nber_subcategory_id":25}&f=["inventor_lastknown_city","inventor_lastknown_state"]</a></p>
56 |     </li>
57 |     <li>
58 |     <p>Return the organization names of assigness linked to inventors whose last known location was the city of Washington, D.C.</p>
59 |     <p class="well code"><a href='{{ base_url }}inventors/query?q={"_and":[{"inventor_lastknown_city":"Washington"},{"inventor_lastknown_state":"D.C."}]}&f=["assignee_organization"]'>{{ base_url }}inventors/query?q={"_and":[{"inventor_lastknown_city":"Washington"},{"inventor_lastknown_state":"D.C."}]}&f=["assignee_organization"]</a></p>
60 |     </li>
61 | </ul>
62 | {% endblock %}
63 | 


--------------------------------------------------------------------------------
/querymodule/doc/location.html:
--------------------------------------------------------------------------------
 1 | {% extends "_section.html" %}
 2 | 
 3 | {% block location_section_class %}section-selected{% endblock %}
 4 | 
 5 | {% block section_title %}Location{% endblock %}
 6 | {% block section_title_plural %}Locations{% endblock %}
 7 | 
 8 | {% block section_get_url %}/api/locations/query?q{,f,o,s}{% endblock %}
 9 | {% block section_post_url %}/api/locations/query{% endblock %}
10 | 
11 | {% block section_introduction %}
12 | <p>This will search for locations matching the query string (<span class="code">q</span>) and returning the data fields listed in the field string (<span class="code">f</span>) sorted by the fields in the sort string (<span class="code">s</span>) using options provided in the option string (<span class="code">o</span>).</p>
13 | {% endblock %}
14 | 
15 | {% block section_query_example %}
16 | {"location_city":"Mount Airy"}
17 | {% endblock %}
18 | 
19 | {% block section_field_defaults %}
20 | <span class="code">location_id</span>, <span class="code">location_city</span>, <span class="code">location_state</span>, and <span class="code">location_country</span>
21 | {% endblock %}
22 | 
23 | {% block section_field_example %}
24 | ["location_id", "location_city","location_state"]
25 | {% endblock %}
26 | 
27 | {% block section_sort_default %}
28 | location_key_id
29 | {% endblock %}
30 | 
31 | {% block section_sort_example %}
32 | [{"location_total_num_inventors":"desc"}]
33 | {% endblock %}
34 | 
35 | {% block section_get_url_example %}
36 | locations/query?q={"location_city":"Mount Airy"}&amp;f=["location_id","location_state","location_total_num_patents"]
37 | {% endblock %}
38 | 
39 | {% block section_post_url_example %}
40 | locations/query
41 | {% endblock %}
42 | 
43 | {% block section_post_body_example %}
44 | {"q":{"location_city":"Mount Airy"},"f":["location_id", "location_state","location_total_num_patents"]}
45 | {% endblock %}
46 | 
47 | {% block section_examples %}
48 | <ul>
49 |     <li>
50 |     <p>Return the last known location of any assigness with patents which have at least one inventor with last name "Yamazaki", "Weder", or "Edison".</p>
51 |     <p class="well code"><a href='{{ base_url }}locations/query?q={"inventor_last_name":["Yamazaki","Weder","Edison"]}&f=["assignee_lastknown_city","assignee_lastknown_state","assignee_lastknown_country"]'>{{ base_url }}locations/query?q={"inventor_last_name":["Yamazaki","Weder","Edison"]}&f=["assignee_lastknown_city","assignee_lastknown_state","assignee_lastknown_country"]</a></p>
52 |     </li>
53 | </ul>
54 | {% endblock %}
55 | 


--------------------------------------------------------------------------------
/querymodule/doc/make_doc.py:
--------------------------------------------------------------------------------
  1 | BASE_URL = "http://www.dev.patentsview.org/api/"
  2 | 
  3 | import glob, jinja2, json, openpyxl, os, shutil, sys
  4 | 
  5 | import xml.etree.ElementTree as ET
  6 | 
  7 | def extract_field_list(ws):
  8 |     ary = []
  9 |     header = None
 10 | 
 11 |     def encode(s):
 12 |         if s:
 13 |             return s.encode("iso-8859-1", "xmlcharrefreplace").decode("utf-8")
 14 |         else:
 15 |             return None
 16 | 
 17 |     for row in ws.iter_rows():
 18 |         values = [encode(cell.value) for cell in row]
 19 | 
 20 |         if not header:
 21 |             header = values
 22 |             continue
 23 | 
 24 |         if not any(values):
 25 |             continue
 26 | 
 27 |         ary.append(dict(zip(header, values)))
 28 | 
 29 |     return sorted(ary, key=lambda x: (x[ "Group"], x["API Field Name"]))
 30 | 
 31 | 
 32 | def snake_case(s):
 33 |     return "_".join(w.lower() for w in s.split())
 34 | 
 35 | 
 36 | def make_documentation_html(outdir):
 37 |     env = jinja2.Environment(loader=jinja2.FileSystemLoader("."), trim_blocks=True, lstrip_blocks=True)
 38 | 
 39 |     # copy css
 40 | 
 41 |     if not os.path.exists(os.path.join(outdir, "css")):
 42 |         os.makedirs(os.path.join(outdir, "css"))
 43 | 
 44 |     shutil.copy("css/custom.css", os.path.join(outdir, "css"))
 45 | 
 46 |     # copy js
 47 | 
 48 |     if not os.path.exists(os.path.join(outdir, "js")):
 49 |         os.makedirs(os.path.join(outdir, "js"))
 50 | 
 51 |     for filename in glob.glob("js/*.js"):
 52 |         shutil.copy(filename, os.path.join(outdir, "js"))
 53 | 
 54 |     # copy images
 55 | 
 56 |     if not os.path.exists(os.path.join(outdir, "img")):
 57 |         os.makedirs(os.path.join(outdir, "img"))
 58 | 
 59 |     for filename in glob.glob("img/*.png"):
 60 |         shutil.copy(filename, os.path.join(outdir, "img"))
 61 |     
 62 |     field_lists = {}
 63 |     wb = openpyxl.load_workbook("API field lists.xlsx", data_only=True, use_iterators=True)
 64 | 
 65 |     if not os.path.exists(os.path.join(outdir, "field_lists")):
 66 |         os.makedirs(os.path.join(outdir, "field_lists"))
 67 | 
 68 |     keep_sections = ["patent", "inventor", "assignee", "cpc subsection", "uspc", "nber subcat", "location"]
 69 |     field_list_column_names = ["API Field Name", "Group", "Common Name", "Type", "Query", "Description"]
 70 | 
 71 |     for ws in wb.worksheets:
 72 |         if ws.title not in keep_sections:
 73 |             continue
 74 | 
 75 |         title = snake_case(ws.title)
 76 |         field_list = extract_field_list(ws)
 77 | 
 78 |         # create the JSON file
 79 | 
 80 |         fname = os.path.join(outdir, "field_lists", "{}.json".format(title))
 81 | 
 82 |         with open(fname, "w") as f:
 83 |             print(json.dumps(field_list), file=f)
 84 | 
 85 |         # build the documentation page for this section
 86 | 
 87 |         fname = os.path.join("{}.html".format(title))
 88 |         page_tpl = env.get_template(fname)
 89 | 
 90 |         fname = os.path.join(outdir, "{}.html".format(title))
 91 | 
 92 |         with open(fname, "w") as f:
 93 |             page = page_tpl.render(field_list_column_names=field_list_column_names, field_list=field_list,
 94 |                                    base_url=BASE_URL)
 95 |             print(page, file=f)
 96 | 
 97 |     # other pages
 98 | 
 99 |     with open("schema/schema.svg") as f:
100 |         schema_svg = f.read() 
101 |     for title in ["doc", "query_language"]:
102 |         fname = os.path.join("{}.html".format(title))
103 |         page_tpl = env.get_template(fname)
104 | 
105 |         fname = os.path.join(outdir, "{}.html".format(title))
106 | 
107 |         with open(fname, "w") as f:
108 |             page = page_tpl.render(schema_svg=schema_svg, base_url=BASE_URL)
109 |             print(page, file=f)
110 | 
111 | 
112 | 
113 | def main(outdir):
114 |     make_documentation_html(outdir)
115 | 
116 | 
117 | if __name__ == "__main__":
118 |     if len(sys.argv) < 2:
119 |         print("USAGE: python make_doc.py DIRECTORY")
120 |         sys.exit(1)
121 | 
122 |     main(sys.argv[1])
123 | 


--------------------------------------------------------------------------------
/querymodule/doc/nber_subcat.html:
--------------------------------------------------------------------------------
 1 | {% extends "_section.html" %}
 2 | 
 3 | {% block nber_subcat_section_class %}section-selected{% endblock %}
 4 | 
 5 | {% block section_title %}NBER Subcategory{% endblock %}
 6 | {% block section_title_plural %}NBER Subcategories{% endblock %}
 7 | 
 8 | {% block section_get_url %}/api/nber_subcategories/query?q{,f,o,s}{% endblock %}
 9 | {% block section_post_url %}/api/nber_subcategories/query{% endblock %}
10 | 
11 | {% block section_introduction %}
12 | <p>This will search for NBER (National Bureau of Economic Research) subcategories matching the query string (<span class="code">q</span>) and returning the data fields listed in the field string (<span class="code">f</span>) sorted by the fields in the sort string (<span class="code">s</span>) using options provided in the option string (<span class="code">o</span>).</p>
13 | {% endblock %}
14 | 
15 | {% block section_query_example %}
16 | {"nber_subcategory_id":"62"}
17 | {% endblock %}
18 | 
19 | {% block section_field_defaults %}
20 | <span class="code">nber_subcategory_id</span> and <span class="code">nber_subcategory_title</span>
21 | {% endblock %}
22 | 
23 | {% block section_field_example %}
24 | ["nber_subcategory_id", "nber_subcategory_title","nber_total_num_patents"]
25 | {% endblock %}
26 | 
27 | {% block section_sort_default %}
28 | nber_subcategory_id
29 | {% endblock %}
30 | 
31 | {% block section_sort_example %}
32 | [{"nber_total_num_patents":"desc"}]
33 | {% endblock %}
34 | 
35 | {% block section_get_url_example %}
36 | nber_subcategories/query?q={"nber_subcategory_id":"62"}&amp;f=["nber_subcategory_id","nber_subcategory_title","nber_total_num_patents"]
37 | {% endblock %}
38 | 
39 | {% block section_post_url_example %}
40 | nber_subcategories/query
41 | {% endblock %}
42 | 
43 | {% block section_post_body_example %}
44 | {"q":{"nber_subcategory_id":"62"},"f":["nber_subcategory_id", "nber_subcategory_title","nber_total_num_patents"]}
45 | {% endblock %}
46 | 
47 | {% block section_examples %}
48 | <ul>
49 |     <li>
50 |     <p>Return the number of patents in each NBER subcategory in 1991, 2001, and 2011.</p>
51 |     <p class="well code"><a href='{{ base_url }}nber_subcategories/query?q={"year_id":["1991","2001","2011"]}&f=["year_id","nber_subcategory_id","nber_subcategory_title","year_num_patents_for_nber_subcategory"]'>{{ base_url }}nber_subcategories/query?q={"year_id":["1991","2001","2011"]}&f=["year_id","nber_subcategory_id","nber_subcategory_title", "year_num_patents_for_nber_subcategory"]</a></p>
52 |     </li>
53 | </ul>
54 | {% endblock %}
55 | 


--------------------------------------------------------------------------------
/querymodule/doc/patent.html:
--------------------------------------------------------------------------------
 1 | {% extends "_section.html" %}
 2 | 
 3 | {% block patent_section_class %}section-selected{% endblock %}
 4 | 
 5 | {% block section_title %}Patent{% endblock %}
 6 | {% block section_title_plural %}Patents{% endblock %}
 7 | 
 8 | {% block section_get_url %}/api/patents/query?q{,f,o,s}{% endblock %}
 9 | {% block section_post_url %}/api/patents/query{% endblock %}
10 | 
11 | {% block section_introduction %}
12 | <p>This will search for patents matching the query string (<span class="span">q</span>) and returning the data fields listed in the field string (<span class="code">f</span>) sorted by the fields in the sort string (<span class="code">s</span>) using options provided in the option string (<span class="code">o</span>).</p>
13 | {% endblock %}
14 | 
15 | {% block section_query_example %}
16 | {"inventor_last_name":"Whitney"}
17 | {% endblock %}
18 | 
19 | {% block section_field_defaults %}
20 | <span class="code">patent_id</span>, <span class="code">patent_number</span>, and <span class="code">patent_title</span>
21 | {% endblock %}
22 | 
23 | {% block section_field_example %}
24 | ["patent_number", "date"]
25 | {% endblock %}
26 | 
27 | {% block section_sort_default %}
28 | patent_number
29 | {% endblock %}
30 | 
31 | {% block section_sort_example %}
32 | [{"patent_number":"desc"}]
33 | {% endblock %}
34 | 
35 | {% block section_get_url_example %}
36 | patents/query?q={"_gte":{"patent_date":"2007-01-04"}}&f=["patent_number","patent_date"]
37 | {% endblock %}
38 | 
39 | {% block section_post_url_example %}
40 | patents/query
41 | {% endblock %}
42 | 
43 | {% block section_post_body_example %}
44 | {"q":{"_gte":{"patent_date":"2007-01-04"}},"f":["patent_number","patent_date"]}
45 | {% endblock %}
46 | 
47 | {% block section_examples %}
48 | <ul>
49 |     <li>
50 |         <p>Return all patent numbers and titles after 2006 where the inventor's last name was "Jobs" and the assignee was based in the US.</p>
51 |         <p class="well code"><a href='{{ base_url }}patents/query?q={"_and":[{"inventor_last_name":"Jobs"},{"assignee_lastknown_country":"US"}]}&f=["patent_number"]'>{{ base_url }}patents/query?q={"_and":[{"inventor_last_name":"Jobs"},{"assignee_lastknown_country":"US"}]}&f=["patent_number"]</a></p>
52 |     </li>
53 |     <li>
54 |         <p>Return the patent number, processing time, and patent kind for patents granted after 2001 that have the word "international" in the abstract and have a foreign company or corporation assignee.</p>
55 |         <p class="well code"><a href='{{ base_url }}patents/query?q={"_and": [{"_gte":{"patent_date":"2001-01-01"}},{"_text_any":{"patent_abstract":"international"}},{"_neq":{"assignee_lastknown_country":"US"}}]}&f=["patent_number","patent_processing_time","patent_kind"]'>{{ base_url }}patents/query?q={"_and": [{"_gte":{"patent_date":"2001-01-01"}},{"_text_any":{"patent_abstract":"international"}},{"_neq":{"assignee_lastknown_country":"US"}}]}&f=["patent_number","patent_processing_time","patent_kind"]</a></p>
56 |     </li>
57 | </ul>
58 | {% endblock %}
59 | 


--------------------------------------------------------------------------------
/querymodule/doc/schema/README.md:
--------------------------------------------------------------------------------
 1 | Create an empty sqlite3 database using `fake_schema.sql`.
 2 | 
 3 |     sqlite3 fake.db < fake_schema.sql
 4 | 
 5 | Run [schemacrawler](http://schemacrawler.sourceforge.net/) to generate the SVG.
 6 | 
 7 |     sc -server=sqlite -database=fake.db -password= -infolevel=standard -portablenames -command=graph -outputformat=svg
 8 | 
 9 |     Rename the output to `schema.svg`
10 | 


--------------------------------------------------------------------------------
/querymodule/doc/temp/css/custom.css:
--------------------------------------------------------------------------------
 1 | body {
 2 |     padding-top: 80px;
 3 | }
 4 | 
 5 | a.anchor {
 6 |     display: block;
 7 |     position: relative;
 8 |     top: -75px;
 9 |     visibility: hidden;
10 | }
11 | 
12 | .navbar {
13 |     background-image: linear-gradient(#54677B, #48596A);
14 | }
15 | 
16 | .navbar-inverse .navbar-nav > .active > a {
17 |     background-image: none;
18 |     background-color: transparent;
19 | }
20 | 
21 | #contents {
22 |     position: fixed;
23 | }
24 | 
25 | #contents .section-list {
26 |     display: none;
27 | }
28 | 
29 | #contents li.section-selected {
30 |     background-color: #EEEEEE;
31 | }
32 | 
33 | #contents li.section-selected .section-list {
34 |     display: inherit;
35 | }
36 | 
37 | #contents p.section-name {
38 |     font-weight: bold;
39 | }
40 | 
41 | #contents ul.section-list {
42 |     list-style-type: none;
43 |     padding: 0 10px;
44 |     margin: 0;
45 | }
46 | 
47 | #documentation .code {
48 |     font-family: monospace;
49 | }
50 | 
51 | #documentation .documentation-parameters {
52 |     font-size: 12px;
53 | }
54 | 
55 | #documentation .documentation-fieldlist {
56 |     font-size: 12px;
57 | }
58 | 
59 | #diagram {
60 |     border: dashed 2px lightgray;
61 | }
62 | 
63 | #diagram svg {
64 |     display: inline;
65 |     width: 100%;
66 |     min-width: inherit;
67 |     max-width: 100%;
68 |     height: 700px;
69 |     min-height: inherit;
70 |     max-height: 900px;
71 | }
72 | 


--------------------------------------------------------------------------------
/querymodule/doc/temp/img/logo.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/PatentsView/PatentsView-API/86c2dd44cc0ac5b123d9b97bbad0f0efc6cf1992/querymodule/doc/temp/img/logo.png


--------------------------------------------------------------------------------
/querymodule/doc/uspc.html:
--------------------------------------------------------------------------------
 1 | {% extends "_section.html" %}
 2 | 
 3 | {% block uspc_section_class %}section-selected{% endblock %}
 4 | 
 5 | {% block section_title %}USPC Mainclass{% endblock %}
 6 | {% block section_title_plural %}USPC Mainclasses{% endblock %}
 7 | 
 8 | {% block section_get_url %}/api/uspc_mainclasses/query?q{,f,o,s}{% endblock %}
 9 | {% block section_post_url %}/api/uspc_mainclasses/query{% endblock %}
10 | 
11 | {% block section_introduction %}
12 | <p>This will search for USPC (United States Patent Classification) mainclasses matching the query string (<span class="code">q</span>) and returning the data fields listed in the field string (<span class="code">f</span>) sorted by the fields in the sort string (<span class="code">s</span>) using options provided in the option string (<span class="code">o</span>).</p>
13 | {% endblock %}
14 | 
15 | {% block section_query_example %}
16 | {"uspc_mainclass_id":"292"}
17 | {% endblock %}
18 | 
19 | {% block section_field_defaults %}
20 | <span class="code">uspc_mainclass_id</span> and <span class="code">uspc_mainclass_title</span>
21 | {% endblock %}
22 | 
23 | {% block section_field_example %}
24 | ["uspc_mainclass_id", "uspc_mainclass_title","uspc_total_num_patents"]
25 | {% endblock %}
26 | 
27 | {% block section_sort_default %}
28 | uspc_mainclass_id
29 | {% endblock %}
30 | 
31 | {% block section_sort_example %}
32 | [{"uspc_total_num_patents":"desc"}]
33 | {% endblock %}
34 | 
35 | {% block section_get_url_example %}
36 | uspc_mainclasses/query?q={"uspc_mainclass_id":"292"}&amp;f=["uspc_mainclass_id","uspc_mainclass_title","uspc_total_num_patents"]
37 | {% endblock %}
38 | 
39 | {% block section_post_url_example %}
40 | uspc_mainclasses/query
41 | {% endblock %}
42 | 
43 | {% block section_post_body_example %}
44 | {"q":{"uspc_mainclass_id":"292"},"f":["uspc_mainclass_id", "uspc_mainclass_title","uspc_total_num_patents"]}
45 | {% endblock %}
46 | 
47 | {% block section_examples %}
48 | <ul>
49 |     <li>
50 |     <p>Return inventor names for patents whose assignee organization contains the word "Census", whose grant date is between 2000 and 2010, and whose USPC mainclass title contains the word "Electricity".</p>
51 |     <p class="well code"><a href='{{ base_url }}uspc_mainclasses/query?q={"_and":[{"_contains":{"assignee_organization":"Census"}},{"_gte":{"patent_date":"2000-01-01"}},{"_lte":{"patent_date":"2010-12-31"}},{"_contains":{"uspc_mainclass_title":"Electricity"}}]}&f=["inventor_id","inventor_first_name","inventor_last_name"]'>{{ base_url }}uspc_mainclasses/query?q={"_and":[{"_contains":{"assignee_organization":"Census"}},{"_gte":{"patent_date":"2000-01-01"}},{"_lte":{"patent_date":"2010-12-31"}},{"_contains":{"uspc_mainclass_title":"Electricity"}}]}&f=["inventor_id","inventor_first_name","inventor_last_name"]</a></p>
52 |     </li>
53 | </ul>
54 | {% endblock %}
55 | 


--------------------------------------------------------------------------------
/querymodule/public_html/index.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | ini_set('max_execution_time', 400);
 3 | // Step 1: Require the Slim Framework
 4 | 
 5 | 
 6 | // config.php provides global configuration class instance (db details, solr details etc)
 7 | require_once dirname(__FILE__) . '/../app/Config.php';
 8 | require __DIR__ . '/../vendor/autoload.php';
 9 | require_once dirname(__FILE__) . '/../app/ErrorHandler.php';
10 | require_once dirname(__FILE__) . '/../app/Exceptions/APIError.php';
11 | 
12 | 
13 | $config = Config::getInstance();
14 | $logger = \ErrorHandler::getHandler()->getLogger($config);
15 | $appConfig = [
16 |     'settings' => [
17 |         'displayErrorDetails' => false,
18 | 
19 | //        'logger' => [
20 | //            'name' => 'slim-app',
21 | //            'level' => 'info',
22 | //            'path' => 'php://stderr',
23 | //        ],
24 |     ],
25 | ];
26 | 
27 | if (Config::MODE == 'development') {
28 |     $appConfig = [
29 |         'settings' => [
30 |             'displayErrorDetails' => false,
31 |         ],
32 |     ];
33 | 
34 | }
35 | // Step 2: Instantiate a Slim application
36 | $app = new \Slim\App($appConfig);
37 | $c = $app->getContainer();
38 | $c['errorHandler'] = function ($c) {
39 |     return function ($request, $response, $exception) use ($c) {
40 |         global $config;
41 |         $status = $exception->getCode() ?: 500;
42 |         $logger = \ErrorHandler::getHandler()->getLogger($config);
43 |         $ip = $request->getServerParam('REMOTE_ADDR');
44 |         $customCode = $exception->getCustomCode();
45 |         $query = $request->getUri();
46 |         $logger->error("$status\t$ip\t$query");
47 | //        $logger->debug("$exception->getMessage()");
48 | //
49 |         return $response->withHeader("X-Status-Reason", $exception->getMessage())->withJson(array("status" => "error", "payload" => array("error" => $exception->getMessage(), "code" => $customCode)), $status);
50 |     };
51 | };
52 | 
53 | // Step 3: Define the Slim application routes
54 | 
55 | // GET route
56 | 
57 | require_once '../app/routes/query.php';
58 | 
59 | 
60 | // Step 4: Run the Slim application
61 | $app->run();
62 | 


--------------------------------------------------------------------------------
/querymodule/resources/logger-config.xml:
--------------------------------------------------------------------------------
 1 | <configuration xmlns="http://logging.apache.org/log4php/">
 2 | 
 3 | 
 4 |     <appender name="default" class="LoggerAppenderConsole" threshold="info">
 5 |         <layout class="LoggerLayoutSimple"/>
 6 |     </appender>
 7 | 
 8 |     <appender name="logFile" class="LoggerAppenderDailyFile" threshold="debug">
 9 |         <layout class="LoggerLayoutPattern">
10 |             <param name="conversionPattern" value="%date %sid %file %line %logger %-5level %msg%n"/>
11 |         </layout>
12 |         <param name="file" value="/var/log/pvapi/file-%s.log"/>
13 |         <param name="datePattern" value="Y-m-d"/>
14 |     </appender>
15 | 
16 |     <root>
17 |         <appender_ref ref="default"/>
18 |         <appender_ref ref="logFile"/>
19 |     </root>
20 | </configuration>


--------------------------------------------------------------------------------
/querymodule/tests/ConfigTest.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Created by PhpStorm.
 4 |  * User: smadhavan
 5 |  * Date: 8/16/18
 6 |  * Time: 1:22 PM
 7 |  */
 8 | 
 9 | require_once dirname(__FILE__) . '/../app/Config.php';
10 | 
11 | class ConfigTest extends PHPUnit_Framework_TestCase
12 | {
13 |     public function testDBSettings()
14 |     {
15 |         $c = $this->init_config();
16 |         $dbs = $c->getDbSettings();
17 |         $this->assertEquals(6, count($dbs));
18 |         $this->assertArrayHasKey("host", $dbs);
19 |         $this->assertArrayHasKey("port", $dbs);
20 |         $this->assertArrayHasKey("user", $dbs);
21 |         $this->assertArrayHasKey("password", $dbs);
22 |         $this->assertArrayHasKey("database", $dbs);
23 |         $this->assertArrayHasKey("supportDatabase", $dbs);
24 |     }
25 | 
26 |     private function init_config($correct = true)
27 |     {
28 |         $c = null;
29 |         if ($correct) {
30 |             $ini_path = "/Users/smadhavan/Universe/Projects/webapps/current/querymodule/tests/inis/correct-db";
31 |             putenv("CONFIG_PATH=$ini_path");
32 |             $c = Config::getInstance();
33 |         }
34 |         return $c;
35 |     }
36 | 
37 |     public function testPageSettings()
38 |     {
39 |         $c = $this->init_config();
40 |         $this->assertEquals(10000, $c->getMaxPageSize());
41 |         $this->assertEquals(100000, $c->getQueryResultLimit());
42 |     }
43 | 
44 |     private function getDBSettings()
45 |     {
46 |         return array(array("/Users/smadhavan/Universe/Projects/webapps/current/querymodule/tests/inis/incorrect-syntax", "/Users/smadhavan/Universe/Projects/webapps/current/querymodule/app/specs"));
47 |     }
48 | }
49 | 


--------------------------------------------------------------------------------
/querymodule/tests/EntitySpecsTest.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | /**
  3 |  * Created by PhpStorm.
  4 |  * User: smadhavan
  5 |  * Date: 9/28/18
  6 |  * Time: 5:10 PM
  7 |  */
  8 | putenv("CONFIG_PATH=/var/app/current");
  9 | require_once dirname(__FILE__) . '/../app/entitySpecs.php';
 10 | require_once dirname(__FILE__) . '/../app/DatabaseQuery.php';
 11 | require_once dirname(__FILE__) . '/../app/Config.php';
 12 | 
 13 | class EntitySpecsTest extends PHPUnit_Framework_TestCase
 14 | {
 15 |     private $db = null;
 16 | 
 17 |     public function __construct($name = null, array $data = [], $dataName = '')
 18 |     {
 19 |         parent::__construct($name, $data, $dataName);
 20 |     }
 21 | 
 22 |     /**
 23 |      * @dataProvider provideEntitySpec
 24 |      **/
 25 | 
 26 |     public function test_spec_array($entitySpecs)
 27 |     {
 28 |         $this->assertNotEquals(0, count($entitySpecs));
 29 |     }
 30 | 
 31 |     /**
 32 |      * @dataProvider provideEntitySpec
 33 |      **/
 34 |     public function test_join($entitySpecs)
 35 |     {
 36 |         $first = True;
 37 |         $select = "SELECT * FROM ";
 38 |         $limit = " WHERE 1=0";
 39 |         $baseQuery = "";
 40 |         $this->connectToDB();
 41 |         foreach ($entitySpecs as $entity) {
 42 |             if ($first) {
 43 |                 $queryToTest = $select . $entity["join"] . $limit;
 44 |                 $baseQuery = $entity["join"];
 45 | 
 46 |                 try {
 47 |                     $st = $this->db->query($queryToTest, PDO::FETCH_ASSOC);
 48 |                     $results = $st->fetchAll();
 49 |                     $st->closeCursor();
 50 |                     $this->assertEquals(0, count($results));
 51 |                 } catch (PDOException $e) {
 52 |                     $this->fail("Base Query Fail" . $queryToTest);
 53 |                 }
 54 | 
 55 |                 $first = False;
 56 |                 continue;
 57 |             }
 58 |             $queryToTest = $select . $baseQuery . " " . $entity["join"] . $limit;
 59 |             try {
 60 |                 $st = $this->db->query($queryToTest, PDO::FETCH_ASSOC);
 61 |                 $results = $st->fetchAll();
 62 |                 $st->closeCursor();
 63 |                 $this->assertEquals(0, count($results));
 64 |             } catch (PDOException $e) {
 65 |                 $this->fail("Join Query Fail: " . $queryToTest);
 66 |             }
 67 |         }
 68 |     }
 69 | 
 70 |     private function connectToDB()
 71 |     {
 72 | 
 73 |         $config = Config::getInstance();
 74 |         if ($this->db === null) {
 75 |             $dbSettings = $config->getDbSettings();
 76 |             $this->db = new PDO("mysql:host=$dbSettings[host];dbname=$dbSettings[database];charset=utf8", $dbSettings['user'], $dbSettings['password']);
 77 |             $this->db->setAttribute(PDO::ATTR_ERRMODE, PDO::ERRMODE_EXCEPTION);
 78 | 
 79 | 
 80 |         }
 81 | 
 82 |     }
 83 | 
 84 |     /**
 85 |      * @dataProvider provideSpec
 86 |      */
 87 |     public function test_field($entitySpecs, $fieldSpecs)
 88 |     {
 89 |         $first = True;
 90 | 
 91 |         $limit = " WHERE 1=0";
 92 |         $baseQuery = "";
 93 |         $this->connectToDB();
 94 |         foreach ($entitySpecs as $entity) {
 95 |             foreach ($fieldSpecs as $fieldSpec) {
 96 |                 if ($fieldSpec["entity_name"] === $entity["entity_name"]) {
 97 |                     $select = "SELECT " . $fieldSpec["column_name"] . " FROM ";
 98 |                     if ($first) {
 99 |                         $queryToTest = $select . $entity["join"] . $limit;
100 |                         $baseQuery = $entity["join"];
101 | 
102 |                         try {
103 |                             $st = $this->db->query($queryToTest, PDO::FETCH_ASSOC);
104 |                             $results = $st->fetchAll();
105 |                             $st->closeCursor();
106 |                             $this->assertEquals(0, count($results));
107 |                         } catch (PDOException $e) {
108 |                             $this->fail("Field failed for Base Query Fail" . $queryToTest);
109 |                         }
110 |                     } else {
111 |                         $queryToTest = $select . $baseQuery . " " . $entity["join"] . $limit;
112 |                         try {
113 |                             $st = $this->db->query($queryToTest, PDO::FETCH_ASSOC);
114 |                             $results = $st->fetchAll();
115 |                             $st->closeCursor();
116 |                             $this->assertEquals(0, count($results));
117 |                         } catch (PDOException $e) {
118 |                             $this->fail("Join Query Fail: " . $queryToTest);
119 |                         }
120 |                     }
121 |                 }
122 |             }
123 |             $first = False;
124 |         }
125 |     }
126 | 
127 |     public
128 |     function provideEntitySpec()
129 |     {
130 |         global $PATENT_ENTITY_SPECS, $ASSIGNEE_ENTITY_SPECS, $INVENTOR_ENTITY_SPECS, $LOCATION_ENTITY_SPECS, $USPC_ENTITY_SPECS, $CPC_ENTITY_SPECS, $NBER_ENTITY_SPECS, $CPC_GROUP_ENTITY_SPECS;
131 | 
132 |         return [[$PATENT_ENTITY_SPECS], [$ASSIGNEE_ENTITY_SPECS], [$INVENTOR_ENTITY_SPECS], [$LOCATION_ENTITY_SPECS], [$USPC_ENTITY_SPECS], [$CPC_ENTITY_SPECS], [$NBER_ENTITY_SPECS], [$CPC_GROUP_ENTITY_SPECS]];
133 |     }
134 | 
135 |     public
136 |     function provideSpec()
137 |     {
138 |         global $PATENT_ENTITY_SPECS, $ASSIGNEE_ENTITY_SPECS, $INVENTOR_ENTITY_SPECS, $LOCATION_ENTITY_SPECS, $USPC_ENTITY_SPECS, $CPC_ENTITY_SPECS, $NBER_ENTITY_SPECS, $CPC_GROUP_ENTITY_SPECS, $PATENT_FIELD_SPECS, $ASSIGNEE_FIELD_SPECS, $INVENTOR_FIELD_SPECS, $LOCATION_FIELD_SPECS, $USPC_FIELD_SPECS, $CPC_FIELD_SPECS, $NBER_FIELD_SPECS, $CPC_GROUP_FIELD_SPECS;
139 | 
140 |         return [[$PATENT_ENTITY_SPECS, $PATENT_FIELD_SPECS], [$ASSIGNEE_ENTITY_SPECS, $ASSIGNEE_FIELD_SPECS], [$INVENTOR_ENTITY_SPECS, $INVENTOR_FIELD_SPECS], [$LOCATION_ENTITY_SPECS, $LOCATION_FIELD_SPECS], [$USPC_ENTITY_SPECS, $USPC_FIELD_SPECS], [$CPC_ENTITY_SPECS, $CPC_FIELD_SPECS], [$NBER_ENTITY_SPECS, $NBER_FIELD_SPECS], [$CPC_GROUP_ENTITY_SPECS, $CPC_GROUP_FIELD_SPECS]];
141 |     }
142 | }
143 | 


--------------------------------------------------------------------------------
/querymodule/tests/QueryParserTest.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Created by PhpStorm.
 4 |  * User: smadhavan
 5 |  * Date: 9/21/18
 6 |  * Time: 12:16 PM
 7 |  */
 8 | require_once dirname(__FILE__) . '/../app/QueryParser.php';
 9 | require_once(dirname(__FILE__) . "/../app/Exceptions/ParsingException.php");
10 | require_once dirname(__FILE__) . '/../app/entitySpecs.php';
11 | class QueryParserTest extends PHPUnit_Framework_TestCase
12 | {
13 |     public function test_invalidField()
14 |     {
15 |         global $PATENT_FIELD_SPECS;
16 |         $pq = new QueryParser();
17 |         $exception = null;
18 |         try {
19 |             $pq->parse($PATENT_FIELD_SPECS, json_decode('{"XYZ":"value"}', true), 'all');
20 |         } catch (\Exceptions\ParsingException $e) {
21 |             $exception = $e->getCustomCode();
22 |         }
23 |         $this->assertEquals("PINV8", $exception);
24 |     }
25 |     public function test_nonQueryField()
26 |     {
27 |         global $PATENT_FIELD_SPECS;
28 |         $pq = new QueryParser();
29 |         $exception = null;
30 |         try {
31 |             $pq->parse($PATENT_FIELD_SPECS, json_decode('{"forprior_sequence":"value"}', true), 'all');
32 |         } catch (\Exceptions\ParsingException $e) {
33 |             $exception = $e->getCustomCode();
34 |         }
35 |         $this->assertEquals("PINV5", $exception);
36 |     }
37 |     public function test_invalidOperation()
38 |     {
39 |         global $PATENT_FIELD_SPECS;
40 | 
41 |         $pq = new QueryParser();
42 |         $exception = null;
43 |         try {
44 |             $pq->parse($PATENT_FIELD_SPECS, json_decode('{"_text_all":{"detail_desc_length":"value"}}', true), 'all');
45 |         } catch (\Exceptions\ParsingException $e) {
46 |             $exception = $e->getCustomCode();
47 |         }
48 |         $this->assertEquals("PINV7", $exception);
49 |     }
50 |     public function test_invalidDataType()
51 |     {
52 |         global $PATENT_FIELD_SPECS;
53 |         global $USPC_FIELD_SPECS;
54 |         $pq = new QueryParser();
55 |         $exception = null;
56 |         try {
57 |             $pq->parse($PATENT_FIELD_SPECS, json_decode('{"detail_desc_length":"value"}', true), 'all');
58 |         } catch (\Exceptions\ParsingException $e) {
59 |             $exception = $e->getCustomCode();
60 |         }
61 |         $this->assertEquals("PINV1", $exception);
62 | 
63 |         $exception = null;
64 |         try {
65 |             $pq->parse($USPC_FIELD_SPECS, json_decode('{"assignee_lastknown_latitude":"String"}', true), 'all');
66 |         } catch (\Exceptions\ParsingException $e) {
67 |             $exception = $e->getCustomCode();
68 |         }
69 |         $this->assertEquals("PINV2", $exception);
70 | 
71 |         $exception = null;
72 |         try {
73 |             $pq->parse($PATENT_FIELD_SPECS, json_decode('{"patent_date":"value"}', true), 'all');
74 |         } catch (\Exceptions\ParsingException $e) {
75 |             $exception = $e->getCustomCode();
76 |         }
77 |         $this->assertEquals("PINV3", $exception);
78 |     }
79 | }
80 | 


--------------------------------------------------------------------------------
/querymodule/tests/QueryParser_Test.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | require_once dirname(__FILE__) . '/../app/QueryParser.php';
  3 | 
  4 | class parseQuery_Test extends PHPUnit_Framework_TestCase
  5 | {
  6 | 
  7 |     public function testSimplePair()
  8 |     {
  9 |         global $PATENT_FIELD_SPECS;
 10 |         $pq = new QueryParser();
 11 |         $returnString = $pq->parse($PATENT_FIELD_SPECS, json_decode('{"patent_number":"abc"}', true), 'all');
 12 |         $this->assertEquals("(patent.number = 'abc')", $returnString);
 13 |         $this->assertEquals(array('patent_number'), $pq->getFieldsUsed());
 14 |     }
 15 | 
 16 |     public function testJoin()
 17 |     {
 18 |         global $PATENT_FIELD_SPECS;
 19 |         $pq = new QueryParser();
 20 |         $returnString = $pq->parse($PATENT_FIELD_SPECS, json_decode('{"_and":[{"patent_number":"abc"},{"inventor_last_name":"Hopper"}]}', true), 'all');
 21 |         $this->assertEquals("((patent.number = 'abc') and (inventor.name_last = 'Hopper'))", $returnString);
 22 |         $expectedFields = array('patent_number','inventor_last_name');
 23 |         sort($expectedFields);
 24 |         $usedFields = $pq->getFieldsUsed();
 25 |         sort($usedFields);
 26 |         $this->assertEquals($expectedFields, $usedFields);
 27 |     }
 28 | 
 29 |     public function testComparison()
 30 |     {
 31 |         global $PATENT_FIELD_SPECS;
 32 |         $pq = new QueryParser();
 33 |         $returnString = $pq->parse($PATENT_FIELD_SPECS, json_decode('{"_lt":{"patent_number":"abc"}}', true), 'all');
 34 |         $this->assertEquals("(patent.number < 'abc')", $returnString);
 35 |         $this->assertEquals(array('patent_number'), $pq->getFieldsUsed());
 36 |     }
 37 | 
 38 |     public function testNegation()
 39 |     {
 40 |         global $PATENT_FIELD_SPECS;
 41 |         $pq = new QueryParser();
 42 |         $returnString = $pq->parse($PATENT_FIELD_SPECS, json_decode('{"_not":{"patent_number":"abc"}}', true), 'all');
 43 |         $this->assertEquals("not (patent.number = 'abc')", $returnString);
 44 |         $this->assertEquals(array('patent_number'), $pq->getFieldsUsed());
 45 |     }
 46 | 
 47 |     public function testValueList()
 48 |     {
 49 |         global $PATENT_FIELD_SPECS;
 50 |         $pq = new QueryParser();
 51 |         $returnString = $pq->parse($PATENT_FIELD_SPECS, json_decode('{"inventor_last_name":["Hopper","Whitney"]}', true), 'all');
 52 |         $this->assertEquals("(inventor.name_last in ('Hopper', 'Whitney'))", $returnString);
 53 |         $this->assertEquals(array('inventor_last_name'), $pq->getFieldsUsed());
 54 |     }
 55 | 
 56 |     public function testComplex_1()
 57 |     {
 58 |         global $PATENT_FIELD_SPECS;
 59 |         $pq = new QueryParser();
 60 |         $returnString = $pq->parse($PATENT_FIELD_SPECS, json_decode('{"_and":[{"_gte":{"patent_date":"2007-01-04"}},{"_text_any":{"patent_title":"garment"}},{"inventor_last_name":"Hopper"},{"patent_title":["cotton gin","COBOL"]}]}', true), 'all');
 61 |         $this->assertEquals("((patent.date >= '2007-01-04') and match (patent.title) against ('garment' in boolean mode) and (inventor.name_last = 'Hopper') and (patent.title in ('cotton gin', 'COBOL')))", $returnString);
 62 |         $expectedFields = array('patent_title','inventor_last_name','patent_date');
 63 |         sort($expectedFields);
 64 |         $usedFields = $pq->getFieldsUsed();
 65 |         sort($usedFields);
 66 |         $this->assertSame($expectedFields, $usedFields);
 67 |     }
 68 | 
 69 |     public function testComplex_2()
 70 |     {
 71 |         global $PATENT_FIELD_SPECS;
 72 |         $pq = new QueryParser();
 73 |         $returnString = $pq->parse($PATENT_FIELD_SPECS, json_decode('{"_or":[{"_and":[{"inventor_last_name":"Whitney"},{"_text_phrase":{"patent_title":"cotton gin"}}]},{"_and":[{"inventor_last_name":"Hopper"},{"_text_any":{"patent_title":"COBOL"}}]}]}', true), 'all');
 74 |         $this->assertEquals("(((inventor.name_last = 'Whitney') and match (patent.title) against ('\"cotton gin\"' in boolean mode)) or ((inventor.name_last = 'Hopper') and match (patent.title) against ('COBOL' in boolean mode)))", $returnString);
 75 |         $expectedFields = array('patent_title','inventor_last_name');
 76 |         sort($expectedFields);
 77 |         $usedFields = $pq->getFieldsUsed();
 78 |         sort($usedFields);
 79 |         $this->assertEquals($expectedFields, $usedFields);
 80 |     }
 81 | 
 82 |     public function testStringNotEqual()
 83 |     {
 84 |         global $PATENT_FIELD_SPECS;
 85 |         $pq = new QueryParser();
 86 |         $returnString = $pq->parse($PATENT_FIELD_SPECS, json_decode('{"_neq":{"inventor_last_name":"Whitney"}}', true), 'all');
 87 |         $this->assertEquals("(inventor.name_last <> 'Whitney')", $returnString);
 88 |         $expectedFields = array('inventor_last_name');
 89 |         sort($expectedFields);
 90 |         $usedFields = $pq->getFieldsUsed();
 91 |         sort($usedFields);
 92 |         $this->assertEquals($expectedFields, $usedFields);
 93 |     }
 94 | 
 95 |     public function testStringBegins()
 96 |     {
 97 |         global $PATENT_FIELD_SPECS;
 98 |         $pq = new QueryParser();
 99 |         $returnString = $pq->parse($PATENT_FIELD_SPECS, json_decode('{"_begins":{"inventor_last_name":"Whit"}}', true), 'all');
100 |         $this->assertEquals("(inventor.name_last like 'Whit%')", $returnString);
101 |         $expectedFields = array('inventor_last_name');
102 |         sort($expectedFields);
103 |         $usedFields = $pq->getFieldsUsed();
104 |         sort($usedFields);
105 |         $this->assertEquals($expectedFields, $usedFields);
106 |     }
107 | 
108 |     /**
109 |      * @expectedException \Exceptions\ParsingException
110 |      */
111 |     public function testInvalidAPIField()
112 |     {
113 |         global $PATENT_FIELD_SPECS;
114 |         $pq = new QueryParser();
115 |         $pq->parse($PATENT_FIELD_SPECS, json_decode('{"XYZ":"value"}', true), 'all');
116 |     }
117 | 
118 |     public function testComplex_1_ByEntity()
119 |     {
120 |         global $PATENT_FIELD_SPECS;
121 |         $pq = new QueryParser();
122 |         $queryString = json_decode('{"_and":[{"assignee_last_name":"Smith"},{"_text_any":{"patent_title":"garment"}},{"inventor_last_name":"Hopper"},{"patent_title":["cotton gin","COBOL"]}]}', true);
123 | 
124 |         $returnString = $pq->parse($PATENT_FIELD_SPECS, $queryString, 'inventor');
125 |         $this->assertEquals("((inventor.name_last = 'Hopper'))", $returnString);
126 |         $expectedFields = array('inventor_last_name');
127 |         sort($expectedFields);
128 |         $usedFields = $pq->getFieldsUsed();
129 |         sort($usedFields);
130 |         $this->assertEquals($expectedFields, $usedFields);
131 |         $this->assertTrue($pq->getOnlyAndsWereUsed());
132 | 
133 |         $returnString = $pq->parse($PATENT_FIELD_SPECS, $queryString, 'assignee');
134 |         $this->assertEquals("((assignee.name_last = 'Smith'))", $returnString);
135 |         $expectedFields = array('assignee_last_name');
136 |         sort($expectedFields);
137 |         $usedFields = $pq->getFieldsUsed();
138 |         sort($usedFields);
139 |         $this->assertEquals($expectedFields, $usedFields);
140 |         $this->assertTrue($pq->getOnlyAndsWereUsed());
141 |     }
142 | 
143 |     public function testComplex_2_ByEntity()
144 |     {
145 |         global $PATENT_FIELD_SPECS;
146 |         $pq = new QueryParser();
147 |         $queryString = json_decode('{"_or":[{"_and":[{"inventor_last_name":"Whitney"},{"_text_phrase":{"patent_title":"cotton gin"}}]},{"_and":[{"inventor_last_name":"Hopper"},{"_text_any":{"patent_title":"COBOL"}}]}]}', true);
148 | 
149 |         $returnString = $pq->parse($PATENT_FIELD_SPECS, $queryString, 'inventor');
150 |         $this->assertEquals("(((inventor.name_last = 'Whitney')) or ((inventor.name_last = 'Hopper')))", $returnString);
151 |         $expectedFields = array('inventor_last_name');
152 |         sort($expectedFields);
153 |         $usedFields = $pq->getFieldsUsed();
154 |         sort($usedFields);
155 |         $this->assertEquals($expectedFields, $usedFields);
156 |         $this->assertFalse($pq->getOnlyAndsWereUsed());
157 |     }
158 | 
159 |     public function testComplex_3_ByEntity()
160 |     {
161 |         global $PATENT_FIELD_SPECS;
162 |         $pq = new QueryParser();
163 |         $queryString = json_decode('{"_or":[{"_and":[{"inventor_last_name":"Whitney"},{"inventor_first_name":"Eli"}]},{"_and":[{"inventor_last_name":"Hopper"},{"_text_any":{"patent_title":"COBOL"}}]}]}', true);
164 | 
165 |         $returnString = $pq->parse($PATENT_FIELD_SPECS, $queryString, 'inventor');
166 |         $this->assertEquals("(((inventor.name_last = 'Whitney') and (inventor.name_first = 'Eli')) or ((inventor.name_last = 'Hopper')))", $returnString);
167 |         $expectedFields = array('inventor_last_name','inventor_first_name');
168 |         sort($expectedFields);
169 |         $usedFields = $pq->getFieldsUsed();
170 |         sort($usedFields);
171 |         $this->assertEquals($expectedFields, $usedFields);
172 |         $this->assertFalse($pq->getOnlyAndsWereUsed());
173 |     }
174 | 
175 |     public function testComplex_4_ByEntity()
176 |     {
177 |         global $PATENT_FIELD_SPECS;
178 |         $pq = new QueryParser();
179 |         $queryString = json_decode('{"_or":[{"_and":[{"inventor_last_name":"Whitney"},{"inventor_first_name":"Eli"}]},{"_text_any":{"patent_title":"COBOL"}}]}', true);
180 | 
181 |         $returnString = $pq->parse($PATENT_FIELD_SPECS, $queryString, 'inventor');
182 |         $this->assertEquals("(((inventor.name_last = 'Whitney') and (inventor.name_first = 'Eli')))", $returnString);
183 |         $expectedFields = array('inventor_last_name','inventor_first_name');
184 |         sort($expectedFields);
185 |         $usedFields = $pq->getFieldsUsed();
186 |         sort($usedFields);
187 |         $this->assertEquals($expectedFields, $usedFields);
188 |         $this->assertFalse($pq->getOnlyAndsWereUsed());
189 | 
190 |         $returnString = $pq->parse($PATENT_FIELD_SPECS, $queryString, 'assignee');
191 |         $this->assertEquals("", $returnString);
192 |         $expectedFields = array();
193 |         sort($expectedFields);
194 |         $usedFields = $pq->getFieldsUsed();
195 |         sort($usedFields);
196 |         $this->assertEquals($expectedFields, $usedFields);
197 |         $this->assertFalse($pq->getOnlyAndsWereUsed());
198 |     }
199 | 
200 | }
201 |  


--------------------------------------------------------------------------------
/querymodule/tests/RouteTest.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | /**
  3 |  * Created by PhpStorm.
  4 |  * User: smadhavan
  5 |  * Date: 9/20/18
  6 |  * Time: 1:36 PM
  7 |  */
  8 | require_once("../app/routes/routeUtilites.php");
  9 | 
 10 | class RouteTest extends PHPUnit_Framework_TestCase
 11 | {
 12 |     public function test_QParam()
 13 |     {
 14 |         $request = array();
 15 |         $processed_array = array();
 16 |         $var_check = null;
 17 |         try {
 18 |             $processed_array = CheckGetParameters($request);
 19 |         } catch (\Exceptions\RequestException $e) {
 20 |             $var_check = $e->getCustomCode();
 21 |         }
 22 |         $this->assertEquals("RQ1", $var_check);
 23 | 
 24 | 
 25 |         $request = array("q" => "random_text. Not valid json");
 26 |         $var_check = null;
 27 |         try {
 28 |             $processed_array = CheckGetParameters($request);
 29 |         } catch (\Exceptions\RequestException $e) {
 30 |             $var_check = $e->getCustomCode();
 31 |         }
 32 |         $this->assertEquals("RQ2", $var_check);
 33 | 
 34 | 
 35 |         $request = array("q" => "{\"key\":\"pair\"}");
 36 |         $processed_array = CheckGetParameters($request);
 37 |         $this->assertGreaterThan(0, count($processed_array));
 38 |         $this->assertEquals(5, count($processed_array));
 39 |         $this->assertNotNull($processed_array[0]);
 40 |         $this->assertEquals("json", $processed_array[4]);
 41 | 
 42 |         $request = array("q" => "{\"key\":\"pair\",\"second_key\":\"second_pair\"}");
 43 |         $var_check = null;
 44 |         try {
 45 |             $processed_array = CheckGetParameters($request);
 46 |         } catch (\Exceptions\RequestException $e) {
 47 |             $var_check = $e->getCustomCode();
 48 |         }
 49 |         $this->assertEquals("RQ3", $var_check);
 50 | 
 51 |     }
 52 | 
 53 |     public function test_fParam()
 54 |     {
 55 | 
 56 | 
 57 |         $request = array("q" => "{\"key\":\"pair\"}", "f" => "random_text. Not valid json");
 58 |         $var_check = null;
 59 |         try {
 60 |             $processed_array = CheckGetParameters($request);
 61 |         } catch (\Exceptions\RequestException $e) {
 62 |             $var_check = $e->getCustomCode();
 63 |         }
 64 |         $this->assertEquals("RF2", $var_check);
 65 | 
 66 | 
 67 |         $request = array("q" => "{\"key\":\"pair\"}", "f" => "{\"key\":\"pair\"}");
 68 |         $processed_array = CheckGetParameters($request);
 69 |         $this->assertGreaterThan(0, count($processed_array));
 70 |         $this->assertEquals(5, count($processed_array));
 71 |         $this->assertNotNull($processed_array[1]);
 72 |     }
 73 | 
 74 |     public function test_sParam()
 75 |     {
 76 |         $request = array("q" => "{\"key\":\"pair\"}", "s" => "random_text. Not valid json");
 77 |         $var_check = null;
 78 |         try {
 79 |             CheckGetParameters($request);
 80 |         } catch (\Exceptions\RequestException $e) {
 81 |             $var_check = $e->getCustomCode();
 82 |         }
 83 |         $this->assertEquals("RS2", $var_check);
 84 | 
 85 | 
 86 |         $request = array("q" => "{\"key\":\"pair\"}", "s" => "{\"key\":\"pair\"}");
 87 |         $processed_array = CheckGetParameters($request);
 88 |         $this->assertGreaterThan(0, count($processed_array));
 89 |         $this->assertEquals(5, count($processed_array));
 90 |         $this->assertNotNull($processed_array[2]);
 91 |     }
 92 | 
 93 |     public function test_oParam()
 94 |     {
 95 |         $request = array("q" => "{\"key\":\"pair\"}", "o" => "random_text. Not valid json");
 96 |         $var_check = null;
 97 |         try {
 98 |             CheckGetParameters($request);
 99 |         } catch (\Exceptions\RequestException $e) {
100 |             $var_check = $e->getCustomCode();
101 |         }
102 |         $this->assertEquals("RO2", $var_check);
103 | 
104 | 
105 |         $request = array("q" => "{\"key\":\"pair\"}", "o" => "{\"key\":\"pair\"}");
106 |         $processed_array = CheckGetParameters($request);
107 |         $this->assertGreaterThan(0, count($processed_array));
108 |         $this->assertEquals(5, count($processed_array));
109 |         $this->assertNotNull($processed_array[3]);
110 |     }
111 | 
112 |     public function test_formatParam()
113 |     {
114 |         $request = array("q" => "{\"key\":\"pair\"}", "format" => "random_text. Not valid json. Not valid anything, Except english sentence, if you ignore character case and punctuation");
115 |         $var_check = null;
116 |         try {
117 |             CheckGetParameters($request);
118 |         } catch (\Exceptions\RequestException $e) {
119 |             $var_check = $e->getCustomCode();
120 |         }
121 |         $this->assertEquals("RFO4", $var_check);
122 | 
123 |         $request = array("q" => "{\"key\":\"pair\"}", "format" => "xml");
124 |         $processed_array = CheckGetParameters($request);
125 |         $this->assertGreaterThan(0, count($processed_array));
126 |         $this->assertEquals(5, count($processed_array));
127 |         $this->assertEquals("xml", $processed_array[4]);
128 | 
129 |         $request = array("q" => "{\"key\":\"pair\"}", "format" => "json");
130 |         $processed_array = CheckGetParameters($request);
131 |         $this->assertGreaterThan(0, count($processed_array));
132 |         $this->assertEquals(5, count($processed_array));
133 |         $this->assertEquals("json", $processed_array[4]);
134 |     }
135 | 
136 | 
137 | }
138 | 


--------------------------------------------------------------------------------
/querymodule/tests/parseQuery_Test.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | require_once dirname(__FILE__) . '/../app/QueryParser.php';
  3 | 
  4 | class parseQuery_Test extends PHPUnit_Framework_TestCase
  5 | {
  6 | 
  7 |     public function testSimplePair()
  8 |     {
  9 |         global $PATENT_FIELD_SPECS;
 10 |         $pq = new QueryParser();
 11 |         $returnString = $pq->parse($PATENT_FIELD_SPECS, json_decode('{"patent_type":"design"}', true), 'all');
 12 |         $this->assertEquals("(patent.type = 'design')", $returnString);
 13 |         $this->assertEquals(array('patent_type'), $pq->getFieldsUsed());
 14 |     }
 15 | 
 16 |     public function testJoin()
 17 |     {
 18 |         global $PATENT_FIELD_SPECS;
 19 |         $pq = new QueryParser();
 20 |         $returnString = $pq->parse($PATENT_FIELD_SPECS, json_decode('{"_and":[{"patent_type":"design"},{"inventor_last_name":"Hopper"}]}', true), 'all');
 21 |         $this->assertEquals("((patent.type = 'design') and (inventor.name_last = 'Hopper'))", $returnString);
 22 |         $expectedFields = array('patent_type','inventor_last_name');
 23 |         sort($expectedFields);
 24 |         $usedFields = $pq->getFieldsUsed();
 25 |         sort($usedFields);
 26 |         $this->assertEquals($expectedFields, $usedFields);
 27 |     }
 28 | 
 29 |     public function testComparison()
 30 |     {
 31 |         global $PATENT_FIELD_SPECS;
 32 |         $pq = new QueryParser();
 33 |         $returnString = $pq->parse($PATENT_FIELD_SPECS, json_decode('{"_lt":{"patent_type":"design"}}', true), 'all');
 34 |         $this->assertEquals("(patent.type < 'design')", $returnString);
 35 |         $this->assertEquals(array('patent_type'), $pq->getFieldsUsed());
 36 |     }
 37 | 
 38 |     public function testNegation()
 39 |     {
 40 |         global $PATENT_FIELD_SPECS;
 41 |         $pq = new QueryParser();
 42 |         $returnString = $pq->parse($PATENT_FIELD_SPECS, json_decode('{"_not":{"patent_type":"design"}}', true), 'all');
 43 |         $this->assertEquals("not (patent.type = 'design')", $returnString);
 44 |         $this->assertEquals(array('patent_type'), $pq->getFieldsUsed());
 45 |     }
 46 | 
 47 |     public function testValueList()
 48 |     {
 49 |         global $PATENT_FIELD_SPECS;
 50 |         $pq = new QueryParser();
 51 |         $returnString = $pq->parse($PATENT_FIELD_SPECS, json_decode('{"inventor_last_name":["Hopper","Whitney"]}', true), 'all');
 52 |         $this->assertEquals("(inventor.name_last in ('Hopper', 'Whitney'))", $returnString);
 53 |         $this->assertEquals(array('inventor_last_name'), $pq->getFieldsUsed());
 54 |     }
 55 | 
 56 |     public function testComplex_1()
 57 |     {
 58 |         global $PATENT_FIELD_SPECS;
 59 |         $pq = new QueryParser();
 60 |         $returnString = $pq->parse($PATENT_FIELD_SPECS, json_decode('{"_and":[{"_gte":{"patent_date":"2007-01-04"}},{"_text_any":{"patent_title":"garment"}},{"inventor_last_name":"Hopper"},{"patent_title":["cotton gin","COBOL"]}]}', true), 'all');
 61 |         $this->assertEquals("((patent.date >= '2007-01-04') and match (patent.title) against ('garment' in boolean mode) and (inventor.name_last = 'Hopper') and (patent.title in ('cotton gin', 'COBOL')))", $returnString);
 62 |         $expectedFields = array('patent_title','inventor_last_name','patent_date');
 63 |         sort($expectedFields);
 64 |         $usedFields = $pq->getFieldsUsed();
 65 |         sort($usedFields);
 66 |         $this->assertSame($expectedFields, $usedFields);
 67 |     }
 68 | 
 69 |     public function testComplex_2()
 70 |     {
 71 |         global $PATENT_FIELD_SPECS;
 72 |         $pq = new QueryParser();
 73 |         $returnString = $pq->parse($PATENT_FIELD_SPECS, json_decode('{"_or":[{"_and":[{"inventor_last_name":"Whitney"},{"_text_phrase":{"patent_title":"cotton gin"}}]},{"_and":[{"inventor_last_name":"Hopper"},{"_text_any":{"patent_title":"COBOL"}}]}]}', true), 'all');
 74 |         $this->assertEquals("(((inventor.name_last = 'Whitney') and match (patent.title) against ('\"cotton gin\"' in boolean mode)) or ((inventor.name_last = 'Hopper') and match (patent.title) against ('COBOL' in boolean mode)))", $returnString);
 75 |         $expectedFields = array('patent_title','inventor_last_name');
 76 |         sort($expectedFields);
 77 |         $usedFields = $pq->getFieldsUsed();
 78 |         sort($usedFields);
 79 |         $this->assertEquals($expectedFields, $usedFields);
 80 |     }
 81 | 
 82 |     public function testStringNotEqual()
 83 |     {
 84 |         global $PATENT_FIELD_SPECS;
 85 |         $pq = new QueryParser();
 86 |         $returnString = $pq->parse($PATENT_FIELD_SPECS, json_decode('{"_neq":{"inventor_last_name":"Whitney"}}', true), 'all');
 87 |         $this->assertEquals("(inventor.name_last <> 'Whitney')", $returnString);
 88 |         $expectedFields = array('inventor_last_name');
 89 |         sort($expectedFields);
 90 |         $usedFields = $pq->getFieldsUsed();
 91 |         sort($usedFields);
 92 |         $this->assertEquals($expectedFields, $usedFields);
 93 |     }
 94 | 
 95 |     public function testStringBegins()
 96 |     {
 97 |         global $PATENT_FIELD_SPECS;
 98 |         $pq = new QueryParser();
 99 |         $returnString = $pq->parse($PATENT_FIELD_SPECS, json_decode('{"_begins":{"inventor_last_name":"Whit"}}', true), 'all');
100 |         $this->assertEquals("(inventor.name_last like 'Whit%')", $returnString);
101 |         $expectedFields = array('inventor_last_name');
102 |         sort($expectedFields);
103 |         $usedFields = $pq->getFieldsUsed();
104 |         sort($usedFields);
105 |         $this->assertEquals($expectedFields, $usedFields);
106 |     }
107 | 
108 |     /**
109 |      * @expectedException Exception
110 |      */
111 |     public function testInvalidAPIField()
112 |     {
113 |         global $PATENT_FIELD_SPECS;
114 |         $pq = new QueryParser();
115 |         $pq->parse($PATENT_FIELD_SPECS, json_decode('{"XYZ":"value"}', true), 'all');
116 |     }
117 | 
118 |     public function testComplex_1_ByEntity()
119 |     {
120 |         global $PATENT_FIELD_SPECS;
121 |         $pq = new QueryParser();
122 |         $queryString = json_decode('{"_and":[{"assignee_last_name":"Smith"},{"_text_any":{"patent_title":"garment"}},{"inventor_last_name":"Hopper"},{"patent_title":["cotton gin","COBOL"]}]}', true);
123 | 
124 |         $returnString = $pq->parse($PATENT_FIELD_SPECS, $queryString, 'inventor');
125 |         $this->assertEquals("((inventor.name_last = 'Hopper'))", $returnString);
126 |         $expectedFields = array('inventor_last_name');
127 |         sort($expectedFields);
128 |         $usedFields = $pq->getFieldsUsed();
129 |         sort($usedFields);
130 |         $this->assertEquals($expectedFields, $usedFields);
131 |         $this->assertTrue($pq->getOnlyAndsWereUsed());
132 | 
133 |         $returnString = $pq->parse($PATENT_FIELD_SPECS, $queryString, 'assignee');
134 |         $this->assertEquals("((assignee.name_last = 'Smith'))", $returnString);
135 |         $expectedFields = array('assignee_last_name');
136 |         sort($expectedFields);
137 |         $usedFields = $pq->getFieldsUsed();
138 |         sort($usedFields);
139 |         $this->assertEquals($expectedFields, $usedFields);
140 |         $this->assertTrue($pq->getOnlyAndsWereUsed());
141 |     }
142 | 
143 |     public function testComplex_2_ByEntity()
144 |     {
145 |         global $PATENT_FIELD_SPECS;
146 |         $pq = new QueryParser();
147 |         $queryString = json_decode('{"_or":[{"_and":[{"inventor_last_name":"Whitney"},{"_text_phrase":{"patent_title":"cotton gin"}}]},{"_and":[{"inventor_last_name":"Hopper"},{"_text_any":{"patent_title":"COBOL"}}]}]}', true);
148 | 
149 |         $returnString = $pq->parse($PATENT_FIELD_SPECS, $queryString, 'inventor');
150 |         $this->assertEquals("(((inventor.name_last = 'Whitney')) or ((inventor.name_last = 'Hopper')))", $returnString);
151 |         $expectedFields = array('inventor_last_name');
152 |         sort($expectedFields);
153 |         $usedFields = $pq->getFieldsUsed();
154 |         sort($usedFields);
155 |         $this->assertEquals($expectedFields, $usedFields);
156 |         $this->assertFalse($pq->getOnlyAndsWereUsed());
157 |     }
158 | 
159 |     public function testComplex_3_ByEntity()
160 |     {
161 |         global $PATENT_FIELD_SPECS;
162 |         $pq = new QueryParser();
163 |         $queryString = json_decode('{"_or":[{"_and":[{"inventor_last_name":"Whitney"},{"inventor_first_name":"Eli"}]},{"_and":[{"inventor_last_name":"Hopper"},{"_text_any":{"patent_title":"COBOL"}}]}]}', true);
164 | 
165 |         $returnString = $pq->parse($PATENT_FIELD_SPECS, $queryString, 'inventor');
166 |         $this->assertEquals("(((inventor.name_last = 'Whitney') and (inventor.name_first = 'Eli')) or ((inventor.name_last = 'Hopper')))", $returnString);
167 |         $expectedFields = array('inventor_last_name','inventor_first_name');
168 |         sort($expectedFields);
169 |         $usedFields = $pq->getFieldsUsed();
170 |         sort($usedFields);
171 |         $this->assertEquals($expectedFields, $usedFields);
172 |         $this->assertFalse($pq->getOnlyAndsWereUsed());
173 |     }
174 | 
175 |     public function testComplex_4_ByEntity()
176 |     {
177 |         global $PATENT_FIELD_SPECS;
178 |         $pq = new QueryParser();
179 |         $queryString = json_decode('{"_or":[{"_and":[{"inventor_last_name":"Whitney"},{"inventor_first_name":"Eli"}]},{"_text_any":{"patent_title":"COBOL"}}]}', true);
180 | 
181 |         $returnString = $pq->parse($PATENT_FIELD_SPECS, $queryString, 'inventor');
182 |         $this->assertEquals("(((inventor.name_last = 'Whitney') and (inventor.name_first = 'Eli')))", $returnString);
183 |         $expectedFields = array('inventor_last_name','inventor_first_name');
184 |         sort($expectedFields);
185 |         $usedFields = $pq->getFieldsUsed();
186 |         sort($usedFields);
187 |         $this->assertEquals($expectedFields, $usedFields);
188 |         $this->assertFalse($pq->getOnlyAndsWereUsed());
189 | 
190 |         $returnString = $pq->parse($PATENT_FIELD_SPECS, $queryString, 'assignee');
191 |         $this->assertEquals("", $returnString);
192 |         $expectedFields = array();
193 |         sort($expectedFields);
194 |         $usedFields = $pq->getFieldsUsed();
195 |         sort($usedFields);
196 |         $this->assertEquals($expectedFields, $usedFields);
197 |         $this->assertFalse($pq->getOnlyAndsWereUsed());
198 |     }
199 | 
200 | }
201 |  


--------------------------------------------------------------------------------
/querymodule/tests/testspec/assignee_master_field_list.json:
--------------------------------------------------------------------------------
1 | {"fields":["app_country","app_date","app_number","app_type","assignee_first_name","assignee_first_seen_date","assignee_id","assignee_key_id","assignee_last_name","assignee_last_seen_date","assignee_lastknown_city","assignee_lastknown_country","assignee_lastknown_latitude","assignee_lastknown_location_id","assignee_lastknown_longitude","assignee_lastknown_state","assignee_organization","assignee_total_num_inventors","assignee_total_num_patents","assignee_type","cpc_category","cpc_first_seen_date","cpc_group_id","cpc_group_title","cpc_last_seen_date","cpc_num_patents_for_assignee","cpc_section_id","cpc_subgroup_id","cpc_subgroup_title","cpc_subsection_id","cpc_subsection_title","cpc_total_num_assignees","cpc_total_num_inventors","cpc_total_num_patents","detail_desc_length","examiner_first_name","examiner_id","examiner_last_name","examiner_role","examiner_group","forprior_country","forprior_date","forprior_docnumber","forprior_kind","forprior_sequence","govint_contract_award_number","govint_org_id","govint_org_level_one","govint_org_level_two","govint_org_level_three","govint_org_name","govint_raw_statement","inventor_city","inventor_country","inventor_county","inventor_county_fips","inventor_first_name","inventor_first_seen_date","inventor_id","inventor_last_name","inventor_last_seen_date","inventor_lastknown_city","inventor_lastknown_country","inventor_lastknown_latitude","inventor_lastknown_location_id","inventor_lastknown_longitude","inventor_lastknown_state","inventor_latitude","inventor_longitude","inventor_num_patents_for_assignee","inventor_state","inventor_state_fips","inventor_total_num_patents","ipc_action_date","ipc_class","ipc_classification_data_source","ipc_classification_value","ipc_first_seen_date","ipc_last_seen_date","ipc_main_group","ipc_section","ipc_subclass","ipc_subgroup","ipc_symbol_position","ipc_total_num_assignees","ipc_total_num_inventors","ipc_version_indicator","lawyer_first_name","lawyer_first_seen_date","lawyer_id","lawyer_last_name","lawyer_last_seen_date","lawyer_organization","lawyer_sequence","lawyer_total_num_assignees","lawyer_total_num_inventors","lawyer_total_num_patents","location_city","location_country","location_county","location_county_fips","location_id","location_latitude","location_longitude","location_state","location_state_fips","nber_category_id","nber_category_title","nber_first_seen_date","nber_last_seen_date","nber_num_patents_for_assignee","nber_subcategory_id","nber_subcategory_title","nber_total_num_assignees","nber_total_num_inventors","nber_total_num_patents","patent_abstract","patent_date","patent_firstnamed_assignee_city","patent_firstnamed_assignee_country","patent_firstnamed_assignee_id","patent_firstnamed_assignee_latitude","patent_firstnamed_assignee_location_id","patent_firstnamed_assignee_longitude","patent_firstnamed_assignee_state","patent_firstnamed_inventor_city","patent_firstnamed_inventor_country","patent_firstnamed_inventor_id","patent_firstnamed_inventor_latitude","patent_firstnamed_inventor_location_id","patent_firstnamed_inventor_longitude","patent_firstnamed_inventor_state","patent_kind","patent_num_cited_by_us_patents","patent_num_claims","patent_num_combined_citations","patent_num_foreign_citations","patent_num_us_application_citations","patent_num_us_patent_citations","patent_number","patent_title","patent_type","pct_102_date","pct_371_date","pct_date","pct_docnumber","pct_doctype","pct_kind","rawinventor_first_name","rawinventor_last_name","uspc_first_seen_date","uspc_last_seen_date","uspc_mainclass_id","uspc_mainclass_title","uspc_num_patents_for_assignee","uspc_sequence","uspc_subclass_id","uspc_subclass_title","uspc_total_num_assignees","uspc_total_num_inventors","wipo_field_id","wipo_field_title","wipo_sector_title","wipo_sequence","year_id","year_num_patents_for_assignee"]}


--------------------------------------------------------------------------------
/querymodule/tests/testspec/cpc_master_field_list.json:
--------------------------------------------------------------------------------
1 | {"fields":["app_country","app_date","app_number","app_type","assignee_city","assignee_country","assignee_county","assignee_county_fips","assignee_first_name","assignee_first_seen_date","assignee_id","assignee_last_name","assignee_last_seen_date","assignee_lastknown_city","assignee_lastknown_country","assignee_lastknown_latitude","assignee_lastknown_location_id","assignee_lastknown_longitude","assignee_lastknown_state","assignee_latitude","assignee_location_id","assignee_longitude","assignee_num_patents_for_cpc_subsection","assignee_organization","assignee_state","assignee_state_fips","assignee_total_num_inventors","assignee_total_num_patents","assignee_type","cpc_group_id","cpc_group_title","cpc_subgroup_id","cpc_subgroup_title","cpc_category","cpc_first_seen_date","cpc_last_seen_date","cpc_section_id","cpc_subsection_id","cpc_subsection_title","cpc_total_num_assignees","cpc_total_num_inventors","cpc_total_num_patents","detail_desc_length","examiner_first_name","examiner_id","examiner_last_name","examiner_role","examiner_group","forprior_country","forprior_date","forprior_docnumber","forprior_kind","forprior_sequence","govint_contract_award_number","govint_org_id","govint_org_level_one","govint_org_level_two","govint_org_level_three","govint_org_name","govint_raw_statement","inventor_city","inventor_country","inventor_county","inventor_county_fips","inventor_first_name","inventor_first_seen_date","inventor_id","inventor_last_name","inventor_last_seen_date","inventor_lastknown_city","inventor_lastknown_country","inventor_lastknown_latitude","inventor_lastknown_location_id","inventor_lastknown_longitude","inventor_lastknown_state","inventor_latitude","inventor_location_id","inventor_longitude","inventor_num_patents_for_cpc_subsection","inventor_state","inventor_state_fips","inventor_total_num_patents","ipc_action_date","ipc_class","ipc_classification_data_source","ipc_classification_value","ipc_first_seen_date","ipc_last_seen_date","ipc_main_group","ipc_section","ipc_subclass","ipc_subgroup","ipc_symbol_position","ipc_total_num_assignees","ipc_total_num_inventors","ipc_version_indicator","lawyer_first_name","lawyer_first_seen_date","lawyer_id","lawyer_last_name","lawyer_last_seen_date","lawyer_organization","lawyer_sequence","lawyer_total_num_assignees","lawyer_total_num_inventors","lawyer_total_num_patents","nber_category_id","nber_category_title","nber_first_seen_date","nber_last_seen_date","nber_subcategory_id","nber_subcategory_title","nber_total_num_assignees","nber_total_num_inventors","nber_total_num_patents","patent_abstract","patent_date","patent_firstnamed_assignee_city","patent_firstnamed_assignee_country","patent_firstnamed_assignee_id","patent_firstnamed_assignee_latitude","patent_firstnamed_assignee_location_id","patent_firstnamed_assignee_longitude","patent_firstnamed_assignee_state","patent_firstnamed_inventor_city","patent_firstnamed_inventor_country","patent_firstnamed_inventor_id","patent_firstnamed_inventor_latitude","patent_firstnamed_inventor_location_id","patent_firstnamed_inventor_longitude","patent_firstnamed_inventor_state","patent_kind","patent_num_cited_by_us_patents","patent_num_claims","patent_num_combined_citations","patent_num_foreign_citations","patent_num_us_application_citations","patent_num_us_patent_citations","patent_number","patent_title","patent_type","pct_102_date","pct_371_date","pct_date","pct_docnumber","pct_doctype","pct_kind","rawinventor_first_name","rawinventor_last_name","uspc_first_seen_date","uspc_last_seen_date","uspc_mainclass_id","uspc_mainclass_title","uspc_sequence","uspc_subclass_id","uspc_subclass_title","uspc_total_num_assignees","uspc_total_num_inventors","uspc_total_num_patents","wipo_field_id","wipo_field_title","wipo_sector_title","wipo_sequence","year_id","year_num_patents_for_cpc_subsection"]}


--------------------------------------------------------------------------------
/querymodule/tests/testspec/inventor_master_field_list.json:
--------------------------------------------------------------------------------
1 | {"fields":["app_country","app_date","app_number","app_type","assignee_city","assignee_country","assignee_county","assignee_county_fips","assignee_first_name","assignee_first_seen_date","assignee_id","assignee_last_name","assignee_last_seen_date","assignee_lastknown_city","assignee_lastknown_country","assignee_lastknown_latitude","assignee_lastknown_location_id","assignee_lastknown_longitude","assignee_lastknown_state","assignee_latitude","assignee_location_id","assignee_longitude","assignee_num_patents_for_inventor","assignee_organization","assignee_state","assignee_state_fips","assignee_total_num_inventors","assignee_total_num_patents","assignee_type","coinventor_city","coinventor_country","coinventor_first_name","coinventor_first_seen_date","coinventor_id","coinventor_last_name","coinventor_last_seen_date","coinventor_lastknown_city","coinventor_lastknown_country","coinventor_lastknown_latitude","coinventor_lastknown_location_id","coinventor_lastknown_longitude","coinventor_lastknown_state","coinventor_num_patents_for_inventor","coinventor_total_num_patents","coinventor_latitude","coinventor_location_id","coinventor_longitude","cpc_category","cpc_first_seen_date","cpc_group_id","cpc_group_title","cpc_last_seen_date","cpc_num_patents_for_inventor","cpc_section_id","cpc_subgroup_id","cpc_subgroup_title","cpc_subsection_id","cpc_subsection_title","cpc_total_num_assignees","cpc_total_num_inventors","cpc_total_num_patents","detail_desc_length","examiner_first_name","examiner_id","examiner_last_name","examiner_role","examiner_group","forprior_country","forprior_date","forprior_docnumber","forprior_kind","forprior_sequence","govint_contract_award_number","govint_org_id","govint_org_level_one","govint_org_level_two","govint_org_level_three","govint_org_name","govint_raw_statement","inventor_first_name","inventor_first_seen_date","inventor_id","inventor_key_id","inventor_last_name","inventor_last_seen_date","inventor_lastknown_city","inventor_lastknown_country","inventor_lastknown_latitude","inventor_lastknown_location_id","inventor_lastknown_longitude","inventor_lastknown_state","inventor_total_num_patents","ipc_action_date","ipc_class","ipc_classification_data_source","ipc_classification_value","ipc_first_seen_date","ipc_last_seen_date","ipc_main_group","ipc_section","ipc_subclass","ipc_subgroup","ipc_symbol_position","ipc_total_num_assignees","ipc_total_num_inventors","ipc_version_indicator","lawyer_first_name","lawyer_first_seen_date","lawyer_id","lawyer_last_name","lawyer_last_seen_date","lawyer_organization","lawyer_sequence","lawyer_total_num_assignees","lawyer_total_num_inventors","lawyer_total_num_patents","location_city","location_country","location_county","location_county_fips","location_latitude","location_id","location_longitude","location_state","location_state_fips","nber_category_id","nber_category_title","nber_first_seen_date","nber_last_seen_date","nber_num_patents_for_inventor","nber_subcategory_id","nber_subcategory_title","nber_total_num_assignees","nber_total_num_inventors","nber_total_num_patents","patent_abstract","patent_date","patent_firstnamed_assignee_city","patent_firstnamed_assignee_country","patent_firstnamed_assignee_id","patent_firstnamed_assignee_latitude","patent_firstnamed_assignee_location_id","patent_firstnamed_assignee_longitude","patent_firstnamed_assignee_state","patent_firstnamed_inventor_city","patent_firstnamed_inventor_country","patent_firstnamed_inventor_id","patent_firstnamed_inventor_latitude","patent_firstnamed_inventor_location_id","patent_firstnamed_inventor_longitude","patent_firstnamed_inventor_state","patent_kind","patent_num_cited_by_us_patents","patent_num_claims","patent_num_combined_citations","patent_num_foreign_citations","patent_num_us_application_citations","patent_num_us_patent_citations","patent_number","patent_title","patent_type","pct_102_date","pct_371_date","pct_date","pct_docnumber","pct_doctype","pct_kind","rawinventor_first_name","rawinventor_last_name","uspc_first_seen_date","uspc_last_seen_date","uspc_mainclass_id","uspc_mainclass_title","uspc_num_patents_for_inventor","uspc_sequence","uspc_subclass_id","uspc_subclass_title","uspc_total_num_assignees","uspc_total_num_inventors","uspc_total_num_patents","wipo_field_id","wipo_field_title","wipo_sector_title","wipo_sequence","year_id","year_num_patents_for_inventor"]}


--------------------------------------------------------------------------------
/querymodule/tests/testspec/location_master_field_list.json:
--------------------------------------------------------------------------------
1 | {"fields":["appcit_app_number","appcit_category","appcit_date","appcit_kind","appcit_sequence","app_country","app_date","app_number","app_type","assignee_first_name","assignee_first_seen_date","assignee_id","assignee_last_name","assignee_last_seen_date","assignee_lastknown_city","assignee_lastknown_country","assignee_lastknown_latitude","assignee_lastknown_location_id","assignee_lastknown_longitude","assignee_lastknown_state","assignee_num_patents_for_location","assignee_organization","assignee_total_num_inventors","assignee_total_num_patents","assignee_type","cited_patent_category","cited_patent_date","cited_patent_kind","cited_patent_number","cited_patent_sequence","cited_patent_title","citedby_patent_category","citedby_patent_date","citedby_patent_kind","citedby_patent_number","citedby_patent_title","cpc_category","cpc_first_seen_date","cpc_group_id","cpc_group_title","cpc_last_seen_date","cpc_num_patents_for_location","cpc_section_id","cpc_sequence","cpc_subgroup_id","cpc_subgroup_title","cpc_subsection_id","cpc_subsection_title","cpc_total_num_assignees","cpc_total_num_inventors","cpc_total_num_patents","detail_desc_length","examiner_first_name","examiner_id","examiner_last_name","examiner_role","examiner_group","forprior_country","forprior_date","forprior_docnumber","forprior_kind","forprior_sequence","govint_contract_award_number","govint_org_id","govint_org_level_one","govint_org_level_two","govint_org_level_three","govint_org_name","govint_raw_statement","inventor_first_name","inventor_first_seen_date","inventor_id","inventor_last_name","inventor_last_seen_date","inventor_lastknown_city","inventor_lastknown_country","inventor_lastknown_latitude","inventor_lastknown_location_id","inventor_lastknown_longitude","inventor_lastknown_state","inventor_num_patents_for_location","inventor_total_num_patents","ipc_action_date","ipc_class","ipc_classification_data_source","ipc_classification_value","ipc_first_seen_date","ipc_last_seen_date","ipc_main_group","ipc_section","ipc_sequence","ipc_subclass","ipc_subgroup","ipc_symbol_position","ipc_total_num_assignees","ipc_total_num_inventors","ipc_version_indicator","lawyer_first_name","lawyer_first_seen_date","lawyer_id","lawyer_last_name","lawyer_last_seen_date","lawyer_organization","lawyer_sequence","lawyer_total_num_assignees","lawyer_total_num_inventors","lawyer_total_num_patents","location_city","location_country","location_county","location_county_fips","location_id","location_key_id","location_latitude","location_longitude","location_state","location_state_fips","location_total_num_assignees","location_total_num_inventors","location_total_num_patents","nber_category_id","nber_category_title","nber_first_seen_date","nber_last_seen_date","nber_num_patents_for_location","nber_subcategory_id","nber_subcategory_title","nber_total_num_assignees","nber_total_num_inventors","nber_total_num_patents","patent_abstract","patent_average_processing_time","patent_date","patent_firstnamed_assignee_city","patent_firstnamed_assignee_country","patent_firstnamed_assignee_id","patent_firstnamed_assignee_latitude","patent_firstnamed_assignee_location_id","patent_firstnamed_assignee_longitude","patent_firstnamed_assignee_state","patent_firstnamed_inventor_city","patent_firstnamed_inventor_country","patent_firstnamed_inventor_id","patent_firstnamed_inventor_latitude","patent_firstnamed_inventor_location_id","patent_firstnamed_inventor_longitude","patent_firstnamed_inventor_state","patent_kind","patent_num_cited_by_us_patents","patent_num_cited_by_us_patents_for_location","patent_num_claims","patent_num_combined_citations","patent_num_foreign_citations","patent_num_us_application_citations","patent_num_us_patent_citations","patent_number","patent_processing_time","patent_title","patent_type","patent_year","pct_102_date","pct_371_date","pct_date","pct_docnumber","pct_doctype","pct_kind","rawinventor_first_name","rawinventor_last_name","uspc_first_seen_date","uspc_last_seen_date","uspc_mainclass_id","uspc_mainclass_title","uspc_num_patents_for_location","uspc_sequence","uspc_subclass_id","uspc_subclass_title","uspc_total_num_assignees","uspc_total_num_inventors","uspc_total_num_patents","wipo_field_id","wipo_field_title","wipo_sector_title","wipo_sequence"]}


--------------------------------------------------------------------------------
/querymodule/tests/testspec/nber_master_field_list.json:
--------------------------------------------------------------------------------
1 | {"fields":["app_country","app_date","app_number","app_type","assignee_city","assignee_country","assignee_county","assignee_county_fips","assignee_first_name","assignee_first_seen_date","assignee_id","assignee_last_name","assignee_last_seen_date","assignee_lastknown_city","assignee_lastknown_country","assignee_lastknown_latitude","assignee_lastknown_location_id","assignee_lastknown_longitude","assignee_lastknown_state","assignee_latitude","assignee_location_id","assignee_longitude","assignee_num_patents_for_nber_subcategory","assignee_organization","assignee_state","assignee_state_fips","assignee_total_num_inventors","assignee_total_num_patents","assignee_type","cpc_group_id","cpc_group_title","cpc_subgroup_id","cpc_subgroup_title","cpc_category","cpc_first_seen_date","cpc_last_seen_date","cpc_section_id","cpc_subsection_id","cpc_subsection_title","cpc_total_num_assignees","cpc_total_num_inventors","cpc_total_num_patents","detail_desc_length","examiner_first_name","examiner_id","examiner_last_name","examiner_role","examiner_group","forprior_country","forprior_date","forprior_docnumber","forprior_kind","forprior_sequence","govint_contract_award_number","govint_org_id","govint_org_level_one","govint_org_level_two","govint_org_level_three","govint_org_name","govint_raw_statement","inventor_city","inventor_country","inventor_county","inventor_county_fips","inventor_first_name","inventor_first_seen_date","inventor_id","inventor_last_name","inventor_last_seen_date","inventor_lastknown_city","inventor_lastknown_country","inventor_lastknown_latitude","inventor_lastknown_location_id","inventor_lastknown_longitude","inventor_lastknown_state","inventor_latitude","inventor_location_id","inventor_longitude","inventor_num_patents_for_nber_subcategory","inventor_state","inventor_state_fips","inventor_total_num_patents","ipc_action_date","ipc_class","ipc_classification_data_source","ipc_classification_value","ipc_first_seen_date","ipc_last_seen_date","ipc_main_group","ipc_section","ipc_subclass","ipc_subgroup","ipc_symbol_position","ipc_total_num_assignees","ipc_total_num_inventors","ipc_version_indicator","lawyer_first_name","lawyer_first_seen_date","lawyer_id","lawyer_last_name","lawyer_last_seen_date","lawyer_organization","lawyer_sequence","lawyer_total_num_assignees","lawyer_total_num_inventors","lawyer_total_num_patents","nber_category_id","nber_category_title","nber_first_seen_date","nber_last_seen_date","nber_subcategory_id","nber_subcategory_title","nber_total_num_assignees","nber_total_num_inventors","nber_total_num_patents","patent_abstract","patent_date","patent_firstnamed_assignee_city","patent_firstnamed_assignee_country","patent_firstnamed_assignee_id","patent_firstnamed_assignee_latitude","patent_firstnamed_assignee_location_id","patent_firstnamed_assignee_longitude","patent_firstnamed_assignee_state","patent_firstnamed_inventor_city","patent_firstnamed_inventor_country","patent_firstnamed_inventor_id","patent_firstnamed_inventor_latitude","patent_firstnamed_inventor_location_id","patent_firstnamed_inventor_longitude","patent_firstnamed_inventor_state","patent_kind","patent_num_cited_by_us_patents","patent_num_claims","patent_num_combined_citations","patent_num_foreign_citations","patent_num_us_application_citations","patent_num_us_patent_citations","patent_number","patent_title","patent_type","pct_102_date","pct_371_date","pct_date","pct_docnumber","pct_doctype","pct_kind","rawinventor_first_name","rawinventor_last_name","uspc_first_seen_date","uspc_last_seen_date","uspc_mainclass_id","uspc_mainclass_title","uspc_sequence","uspc_subclass_id","uspc_subclass_title","uspc_total_num_assignees","uspc_total_num_inventors","uspc_total_num_patents","wipo_field_id","wipo_field_title","wipo_sector_title","wipo_sequence","year_id","year_num_patents_for_nber_subcategory"]}


--------------------------------------------------------------------------------
/querymodule/tests/testspec/patent_master_field_list.json:
--------------------------------------------------------------------------------
1 | {"fields":["appcit_app_number","appcit_category","appcit_date","appcit_kind","appcit_sequence","app_country","app_date","app_number","app_type","assignee_city","assignee_country","assignee_county","assignee_county_fips","assignee_first_name","assignee_first_seen_date","assignee_id","assignee_last_name","assignee_last_seen_date","assignee_lastknown_city","assignee_lastknown_country","assignee_lastknown_latitude","assignee_lastknown_location_id","assignee_lastknown_longitude","assignee_lastknown_state","assignee_latitude","assignee_location_id","assignee_longitude","assignee_organization","assignee_sequence","assignee_state","assignee_state_fips","assignee_total_num_inventors","assignee_total_num_patents","assignee_type","cited_patent_category","cited_patent_date","cited_patent_kind","cited_patent_number","cited_patent_sequence","cited_patent_title","citedby_patent_category","citedby_patent_date","citedby_patent_kind","citedby_patent_number","citedby_patent_title","cpc_category","cpc_first_seen_date","cpc_group_id","cpc_group_title","cpc_last_seen_date","cpc_section_id","cpc_sequence","cpc_subgroup_id","cpc_subgroup_title","cpc_subsection_id","cpc_subsection_title","cpc_total_num_assignees","cpc_total_num_inventors","cpc_total_num_patents","detail_desc_length","examiner_first_name","examiner_id","examiner_last_name","examiner_role","examiner_group","forprior_country","forprior_date","forprior_docnumber","forprior_kind","forprior_sequence","govint_contract_award_number","govint_org_id","govint_org_level_one","govint_org_level_two","govint_org_level_three","govint_org_name","govint_raw_statement","inventor_city","inventor_country","inventor_county","inventor_county_fips","inventor_first_name","inventor_first_seen_date","inventor_id","inventor_last_name","inventor_last_seen_date","inventor_lastknown_city","inventor_lastknown_country","inventor_lastknown_latitude","inventor_lastknown_location_id","inventor_lastknown_longitude","inventor_lastknown_state","inventor_latitude","inventor_location_id","inventor_longitude","inventor_sequence","inventor_state","inventor_state_fips","inventor_total_num_patents","ipc_action_date","ipc_class","ipc_classification_data_source","ipc_classification_value","ipc_first_seen_date","ipc_last_seen_date","ipc_main_group","ipc_section","ipc_sequence","ipc_subclass","ipc_subgroup","ipc_symbol_position","ipc_total_num_assignees","ipc_total_num_inventors","ipc_version_indicator","lawyer_first_name","lawyer_first_seen_date","lawyer_id","lawyer_last_name","lawyer_last_seen_date","lawyer_organization","lawyer_sequence","lawyer_total_num_assignees","lawyer_total_num_inventors","lawyer_total_num_patents","nber_category_id","nber_category_title","nber_first_seen_date","nber_last_seen_date","nber_subcategory_id","nber_subcategory_title","nber_total_num_assignees","nber_total_num_inventors","nber_total_num_patents","patent_abstract","patent_average_processing_time","patent_date","patent_firstnamed_assignee_city","patent_firstnamed_assignee_country","patent_firstnamed_assignee_id","patent_firstnamed_assignee_latitude","patent_firstnamed_assignee_location_id","patent_firstnamed_assignee_longitude","patent_firstnamed_assignee_state","patent_firstnamed_inventor_city","patent_firstnamed_inventor_country","patent_firstnamed_inventor_id","patent_firstnamed_inventor_latitude","patent_firstnamed_inventor_location_id","patent_firstnamed_inventor_longitude","patent_firstnamed_inventor_state","patent_kind","patent_num_cited_by_us_patents","patent_num_claims","patent_num_combined_citations","patent_num_foreign_citations","patent_num_us_application_citations","patent_num_us_patent_citations","patent_number","patent_processing_time","patent_title","patent_type","patent_year","pct_102_date","pct_371_date","pct_date","pct_docnumber","pct_doctype","pct_kind","rawinventor_first_name","rawinventor_last_name","uspc_first_seen_date","uspc_last_seen_date","uspc_mainclass_id","uspc_mainclass_title","uspc_sequence","uspc_subclass_id","uspc_subclass_title","uspc_total_num_assignees","uspc_total_num_inventors","uspc_total_num_patents","wipo_field_id","wipo_field_title","wipo_sector_title","wipo_sequence"]}


--------------------------------------------------------------------------------
/querymodule/tests/testspec/uspc_master_field_list.json:
--------------------------------------------------------------------------------
1 | {"fields":["app_country","app_date","app_number","app_type","assignee_city","assignee_country","assignee_county","assignee_county_fips","assignee_first_name","assignee_first_seen_date","assignee_id","assignee_last_name","assignee_last_seen_date","assignee_lastknown_city","assignee_lastknown_country","assignee_lastknown_latitude","assignee_lastknown_location_id","assignee_lastknown_longitude","assignee_lastknown_state","assignee_latitude","assignee_location_id","assignee_longitude","assignee_num_patents_for_uspc_mainclass","assignee_organization","assignee_state","assignee_state_fips","assignee_total_num_inventors","assignee_total_num_patents","assignee_type","cpc_category","cpc_first_seen_date","cpc_group_id","cpc_group_title","cpc_last_seen_date","cpc_section_id","cpc_subgroup_id","cpc_subgroup_title","cpc_subsection_id","cpc_subsection_title","cpc_total_num_assignees","cpc_total_num_inventors","cpc_total_num_patents","detail_desc_length","examiner_first_name","examiner_id","examiner_last_name","examiner_role","examiner_group","forprior_country","forprior_date","forprior_docnumber","forprior_kind","forprior_sequence","govint_contract_award_number","govint_org_id","govint_org_level_one","govint_org_level_two","govint_org_level_three","govint_org_name","govint_raw_statement","inventor_city","inventor_country","inventor_county","inventor_county_fips","inventor_first_name","inventor_first_seen_date","inventor_id","inventor_last_name","inventor_last_seen_date","inventor_lastknown_city","inventor_lastknown_country","inventor_lastknown_latitude","inventor_lastknown_location_id","inventor_lastknown_longitude","inventor_lastknown_state","inventor_latitude","inventor_location_id","inventor_longitude","inventor_num_patents_for_uspc_mainclass","inventor_state","inventor_state_fips","inventor_total_num_patents","ipc_action_date","ipc_class","ipc_classification_data_source","ipc_classification_value","ipc_first_seen_date","ipc_last_seen_date","ipc_main_group","ipc_section","ipc_subclass","ipc_subgroup","ipc_symbol_position","ipc_total_num_assignees","ipc_total_num_inventors","ipc_version_indicator","lawyer_first_name","lawyer_first_seen_date","lawyer_id","lawyer_last_name","lawyer_last_seen_date","lawyer_organization","lawyer_sequence","lawyer_total_num_assignees","lawyer_total_num_inventors","lawyer_total_num_patents","nber_category_id","nber_category_title","nber_first_seen_date","nber_last_seen_date","nber_subcategory_id","nber_subcategory_title","nber_total_num_assignees","nber_total_num_inventors","nber_total_num_patents","patent_abstract","patent_date","patent_firstnamed_assignee_city","patent_firstnamed_assignee_country","patent_firstnamed_assignee_id","patent_firstnamed_assignee_latitude","patent_firstnamed_assignee_location_id","patent_firstnamed_assignee_longitude","patent_firstnamed_assignee_state","patent_firstnamed_inventor_city","patent_firstnamed_inventor_country","patent_firstnamed_inventor_id","patent_firstnamed_inventor_latitude","patent_firstnamed_inventor_location_id","patent_firstnamed_inventor_longitude","patent_firstnamed_inventor_state","patent_kind","patent_num_cited_by_us_patents","patent_num_claims","patent_num_combined_citations","patent_num_foreign_citations","patent_num_us_application_citations","patent_num_us_patent_citations","patent_number","patent_title","patent_type","pct_102_date","pct_371_date","pct_date","pct_docnumber","pct_doctype","pct_kind","rawinventor_first_name","rawinventor_last_name","uspc_first_seen_date","uspc_last_seen_date","uspc_mainclass_id","uspc_mainclass_title","uspc_total_num_assignees","uspc_total_num_inventors","uspc_total_num_patents","uspc_subclass_id","uspc_subclass_title","wipo_field_id","wipo_field_title","wipo_sector_title","wipo_sequence","year_id","year_num_patents_for_uspc_mainclass"]}


--------------------------------------------------------------------------------
/swagger:
--------------------------------------------------------------------------------
1 | user_contributions/swagger/


--------------------------------------------------------------------------------
/user_contributions/README.md:
--------------------------------------------------------------------------------
1 | # User Contributions
2 | This folder will contain contributions such as documentation, reference etc. made by users of of PatentsView
3 | 
4 | ## Contributions
5 | 
6 | |Contribution| Description| Contributor|Link |
7 | |------------|------------|------------|-----|
8 | |PatentsView API Swagger|  Swagger JSON file that documents the PatentsView API  |[Russ Allen](https://github.com/mustberuss/)| [Link](swagger/README.md)|


--------------------------------------------------------------------------------
/user_contributions/swagger/README.md:
--------------------------------------------------------------------------------
1 | # Swagger for PatentsViewAPI
2 | ## Purpose: Documents API & enables "point and click" querying of PatentsView API 
3 | ## Contributed by: [Russ Allen](https://github.com/mustberuss/)
4 | 
5 | 


--------------------------------------------------------------------------------