node.h

/* Copyright (C) 2018 Chris Piker <chris-piker@uiowa.edu>
 *
 * This file is part of libdas2, the Core Das2 C Library.
 * 
 * Libdas2 is free software; you can redistribute it and/or modify it under
 * the terms of the GNU Lesser General Public License version 2.1 as published
 * by the Free Software Foundation.
 *
 * Libdas2 is distributed in the hope that it will be useful, but WITHOUT ANY
 * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License for
 * more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 2.1 along with libdas2; if not, see <http://www.gnu.org/licenses/>. 
 */
 
#ifndef _das_node_h_
#define _das_node_h_
 
#include <das2/credentials.h>
#include <das2/array.h>
#include <das2/json.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
 
 
/* Defines for common path_uri's */
#define D2URI_ROOT                   "tag:das2.org,2012:"
#define D2URI_SITES      D2URI_ROOT  "site"
#define D2URI_SITE_UIOWA D2URI_SITES ":/uiowa"
         
/* Defines for common document fragments */
#define D2FRAG_TYPE       "type"
#define D2FRAG_NAME       "name"
#define D2FRAG_LABEL      "label"
#define D2FRAG_TITLE      "title"
#define D2FRAG_DESC       "description"
#define D2FRAG_SUB_PATHS  "catalog"
#define D2FRAG_PATH_SEP   "separator"
#define D2FRAG_SOURCES    "sources"
#define D2FRAG_URLS       "urls"
   
/* Defines for common document string values */
#define D2CV_TYPE_CATALOG     "Catalog"
#define D2CV_TYPE_COLLECTION  "Collection"
#define D2CV_TYPE_SRCSET      "SourceSet"
#define D2CV_TYPE_STREAM      "HttpStreamSrc"
#define D2CV_TYPE_TIMEAGG     "FileTimeAgg"
#define D2CV_TYPE_SPASE       "SpaseRecord"
#define D2Cv_TYPE_SPDF_MASTER "SpdfMasterCat"
 
typedef enum das_node_type_enum {
   d2node_inv = 0, d2node_catalog = 1, d2node_collection = 2, 
   d2node_srcset = 3, d2node_stream_src = 4,  d2node_file_agg = 5, 
   d2node_spdf_cat = 6, d2node_spase_cat = 7
} das_node_type_e;
 
typedef struct das_node {
   das_node_type_e nType;  /* Holds the node type */
   char sURL[512];    /* Holds source URL for this node */
   char sPath[512];   /* Holds the Path URI for this node */
   bool bIsRoot;      /* True if a local root node (i.e. is a memory manager) */
   void* pDom;        /* A pointer to the document tokens. */
} DasNode;
 
DAS_API const char** das_root_urls(size_t* pLen);
 
DAS_API DasNode* new_RootNode(
   const char* sPathUri, DasCredMngr* pMgr, const char* sAgent
);
 
DAS_API DasNode* new_RootNode_url(const char* sUrl, const char* sPathUri,
                          DasCredMngr* pMgr, const char* sAgent);
 
DAS_API DasNode* DasNode_subNode(
   DasNode* pThis, const char* sRelPath, DasCredMngr* pMgr, const char* sAgent
);
 
DAS_API bool DasNode_isCatalog(const DasNode* pNode);
 
DAS_API bool DasNode_isStreamSrc(const DasNode* pNode);
 
DAS_API bool DasNode_isSpaseRec(const DasNode* pNode);
 
DAS_API bool DasNode_isSpdfCat(const DasNode* pNode);
 
DAS_API const char* DasNode_pathUri(const DasNode* pThis);
 
DAS_API const char* DasNode_srcUrl(const DasNode* pThis);
 
DAS_API das_node_type_e DasNode_type(const DasNode* pThis);
 
DAS_API const char* DasNode_name(const DasNode* pThis);
 
DAS_API const char* DasNode_title(const DasNode* pThis);
 
 
DAS_API bool DasNode_isJson(const DasNode* pThis);
 
DAS_API const DasJdo* DasNode_getJdo(const DasNode* pThis, const char* sFragment);
 
 
DAS_API const DasJdo* DasNode_getJdoType(
   const DasNode* pThis, enum das_json_type_e, const char* sFragment
);
 
DAS_API void del_RootNode(DasNode* pNode);
 
 
#ifdef __cplusplus
}
#endif
 
#endif /* _das_catalog_h_ */