Developer Documentation
- kuha_common
- server.py
- query.py
- conf.py
- cli_setup.py
- document_store
- document_store/client.py
- document_store/query.py
FilterKeyConstantsQueryExceptionQueryQuery.k_filterQuery.k_fieldsQuery.k_limitQuery.k_skipQuery.k_sort_orderQuery.k_sort_byQuery.k_fieldnameQuery.query_type_selectQuery.query_type_countQuery.query_type_distinctQuery.as_supported_datetime_str()Query.construct()Query.construct_distinct()Query.build_query_for_date_range()Query.build_query_for_exists()Query.get_valid_params()Query.get_required_params()Query.is_valid_query()Query.is_valid_query_type()Query.is_valid_query_document()Query.is_valid_param()Query.validate_query()Query.validate_query_type()Query.validate_query_document()Query.get_endpoint()Query.get_query()Query.get_limit()Query.get_skip()Query.set_limit()Query.set_skip()Query.set_fields()Query.set_sort_by()Query.set_sort_order()Query.set_query_type()Query.add_query_statement()Query.add_query_statements()
- document_store/field_types.py
- document_store/records.py
datetime_to_datestamp()datestamp_to_datetime()datetime_now()path_split()path_join()dig_and_set()RecordBaseRecordBase.get_collection()RecordBase.iterate_record_fields()RecordBase.export_metadata_dict()RecordBase.export_dict()RecordBase.set_updated()RecordBase.set_created()RecordBase.set_deleted()RecordBase.set_cmm_type()RecordBase.set_id()RecordBase.get_updated()RecordBase.get_created()RecordBase.get_deleted()RecordBase.get_id()RecordBase.is_deleted()RecordBase.bypass_update()RecordBase.bypass_create()RecordBase.updates_record()RecordBase.updates()
StudyStudy.study_numberStudy.persistent_identifiersStudy.identifiersStudy.study_titlesStudy.document_titlesStudy.parallel_titlesStudy.principal_investigatorsStudy.publishersStudy.distributorsStudy.document_urisStudy.study_urisStudy.publication_datesStudy.publication_yearsStudy.distribution_datesStudy.abstractStudy.classificationsStudy.keywordsStudy.time_methodsStudy.sampling_proceduresStudy.collection_modesStudy.analysis_unitsStudy.research_instrumentsStudy.collection_periodsStudy.data_kindsStudy.study_area_countriesStudy.geographic_coveragesStudy.universesStudy.data_accessStudy.data_access_descriptionsStudy.citation_requirementsStudy.deposit_requirementsStudy.file_namesStudy.instrumentsStudy.related_publicationsStudy.study_groupsStudy.copyrightsStudy.data_collection_copyrightsStudy.funding_agenciesStudy.grant_numbersStudy.collectionStudy.cmm_typeStudy.add_study_number()Study.add_persistent_identifiers()Study.add_identifiers()Study.add_study_titles()Study.add_document_titles()Study.add_parallel_titles()Study.add_principal_investigators()Study.add_publishers()Study.add_distributors()Study.add_document_uris()Study.add_study_uris()Study.add_publication_dates()Study.add_publication_years()Study.add_distribution_dates()Study.add_abstract()Study.add_classifications()Study.add_keywords()Study.add_time_methods()Study.add_sampling_procedures()Study.add_collection_modes()Study.add_analysis_units()Study.add_research_instruments()Study.add_collection_periods()Study.add_data_kinds()Study.add_study_area_countries()Study.add_geographic_coverages()Study.add_universes()Study.add_data_access()Study.add_data_access_descriptions()Study.add_citation_requirements()Study.add_deposit_requirements()Study.add_file_names()Study.add_instruments()Study.add_related_publications()Study.add_study_groups()Study.add_copyrights()Study.add_data_collection_copyrights()Study.add_funding_agencies()Study.add_grant_numbers()Study.add_document_description_notes()Study.updates()
VariableVariable.study_numberVariable.variable_nameVariable.question_identifiersVariable.variable_labelsVariable.codelist_codesVariable.collectionVariable.cmm_typeVariable.add_study_number()Variable.add_variable_name()Variable.add_question_identifiers()Variable.add_variable_labels()Variable.add_codelist_codes()Variable.updates()
QuestionQuestion.study_numberQuestion.question_identifierQuestion.variable_nameQuestion.question_textsQuestion.research_instrumentsQuestion.codelist_referencesQuestion.collectionQuestion.cmm_typeQuestion.add_study_number()Question.add_question_identifier()Question.add_variable_name()Question.add_question_texts()Question.add_research_instruments()Question.add_codelist_references()Question.updates()
StudyGroupStudyGroup.study_group_identifierStudyGroup.study_group_namesStudyGroup.descriptionsStudyGroup.urisStudyGroup.study_numbersStudyGroup.collectionStudyGroup.cmm_typeStudyGroup.add_study_group_identifier()StudyGroup.add_study_group_names()StudyGroup.add_descriptions()StudyGroup.add_uris()StudyGroup.add_study_numbers()StudyGroup.updates()
record_factory()record_by_collection()
- document_store/mappings
- document_store/mappings/exceptions.py
- document_store/mappings/xmlbase.py
MappedParamsXMLMapperXMLParserBaseXMLParserBase.NSXMLParserBase.default_languageXMLParserBase.from_string()XMLParserBase.from_file()XMLParserBase.child_text()XMLParserBase.root_elementXMLParserBase.root_languageXMLParserBase.study_numberXMLParserBase.study_number_identifierXMLParserBase.studiesXMLParserBase.variablesXMLParserBase.questionsXMLParserBase.study_groupsXMLParserBase.allXMLParserBase.select()
as_valid_identifier()str_equals()fixed_value()element_remove_whitespaces()element_strip_descendant_text()element_strip_descendant_text_by_tag()get_preferred_publication_id_agency_pair()
- document_store/mappings/ddi
- document_store/mappings/ddi/codebook.py
- document_store/mappings/ddi/lifecycle.py
- document_store/mappings/ddi/ddi31.py
- document_store/mappings/ddi/ddi33.py
- testing
- testing/testcases.py
KuhaUnitTestCaseKuhaUnitTestCase.dummydata_dirKuhaUnitTestCase.setUpClass()KuhaUnitTestCase.tearDownClass()KuhaUnitTestCase.get_dummydata_path()KuhaUnitTestCase.get_dummydata()KuhaUnitTestCase.remove_dummyfile_if_exists()KuhaUnitTestCase.set_val()KuhaUnitTestCase.gen_val()KuhaUnitTestCase.gen_id()KuhaUnitTestCase.generate_dummy_study()KuhaUnitTestCase.generate_dummy_variable()KuhaUnitTestCase.generate_dummy_question()KuhaUnitTestCase.generate_dummy_studygroup()KuhaUnitTestCase.run_until_complete()KuhaUnitTestCase.setUp()KuhaUnitTestCase.tearDown()KuhaUnitTestCase.await_and_store_result()KuhaUnitTestCase.init_patcher()KuhaUnitTestCase.assert_records_are_equal()KuhaUnitTestCase.assert_records_are_not_equal()KuhaUnitTestCase.assert_mock_meth_has_calls()
KuhaEndToEndTestCaseKuhaEndToEndTestCase.setUpClass()KuhaEndToEndTestCase.tearDownClass()KuhaEndToEndTestCase.get_record_url()KuhaEndToEndTestCase.get_query_url()KuhaEndToEndTestCase.GET_to_document_store()KuhaEndToEndTestCase.POST_to_document_store()KuhaEndToEndTestCase.DELETE_to_document_store()KuhaEndToEndTestCase.query_document_store()KuhaEndToEndTestCase.get_collection_record_count()KuhaEndToEndTestCase.assert_document_store_is_empty()
- kuha_document_store
- serve.py
- handlers.py
- database.py
Collectionmongodburi()bson_to_json()DatabaseDocumentStoreDatabaseDocumentStoreDatabase.recoverable_errorsDocumentStoreDatabase.json_decode()DocumentStoreDatabase.query_multiple()DocumentStoreDatabase.query_by_oid()DocumentStoreDatabase.query_distinct()DocumentStoreDatabase.insert_json()DocumentStoreDatabase.replace_json()DocumentStoreDatabase.delete_records()
db_from_settings()add_cli_args()
- validation.py
- dbadmin
- dbadmin/operations.py
- kuha_oai_pmh_repo_hander
- constants.py
- serve.py
- controller.py
- genshi_loader.py
- http_api.py
- list_records.py
- metadataformats
DuplicateSetSpecMDFormatMDFormat.overridableMDFormat.study_classMDFormat.variable_classMDFormat.question_classMDFormat.MDSetMDFormat.add_cli_args()MDFormat.configure_sets()MDFormat.configure()MDFormat.get_deleted_record()MDFormat.get_set()MDFormat.get_earliest_datestamp()MDFormat.list_sets()MDFormat.list_identifiers()MDFormat.list_metadata_formats()MDFormat.get_record()MDFormat.list_records()
DCMetadataFormatEAD3MetadataFormatDDICMetadataFormatOAIDDI25MetadataFormatOAIDataciteMetadataFormatOAIDataciteMetadataFormat.overridableOAIDataciteMetadataFormat.add_cli_args()OAIDataciteMetadataFormat.configure()OAIDataciteMetadataFormat.get_preferred_identifier()OAIDataciteMetadataFormat.get_related_identifiers_types()OAIDataciteMetadataFormat.get_publisher_lang_value_pair()OAIDataciteMetadataFormat.get_funders()OAIDataciteMetadataFormat.get_record()OAIDataciteMetadataFormat.list_records()
- metadataformats/const.py
- metadataformats/exc.py
- metadataformats/_mdsets.py
- oai
- oai/errors.py
- oai/constants.py
- oai/protocol.py
- kuha_osmh_repo_handler
- serve.py
- configure.py
- handlers.py
- response.py
- osmh
- osmh/records.py
PayloadOSMHRecordOSMHRecord.osmh_typeOSMHRecord.query_documentOSMHRecord.relative_queries_for_recordOSMHRecord.fields_for_header()OSMHRecord.fields_for_record()OSMHRecord.query_filter_for_record()OSMHRecord.for_header_response()OSMHRecord.for_record_response()OSMHRecord.get_query_document()OSMHRecord.requires_relative_queries_for_record()OSMHRecord.build_header_payload()OSMHRecord.build_record_payload()OSMHRecord.get_payload()
StudyRecordStudyRecord.query_documentStudyRecord.fields_for_header()StudyRecord.fields_for_record()StudyRecord.query_filter_for_record()StudyRecord.get_secondary_query_fields_for_record()StudyRecord.get_secondary_query_document()StudyRecord.get_secondary_query_filter_for_record()StudyRecord.build_relative_record_payload()StudyRecord.build_record_payload()
VariableRecordQuestionRecordStudyGroupRecordget_osmh_record_for_type()
- kuha_client
SourceFileCacheFileLoggingCacheopen_file_logging_cache()DocumentStoreHTTPErrorsend_create_record_request()send_update_record_request()send_delete_record_request()iterate_xml_directory()iterate_xml_files_recursively()CollectionMethodsNoSuchCollectionMethodBatchProcessor- impl.py
- sync.py
- kuha_delete.py