ee9a6c5c63eba2d963a5d7581185b1004fffe964 angie Mon Apr 15 14:06:10 2013 -0700 Added indentifying name to annoStreamer for output header info and better error messages. refs #6152 diff --git src/lib/annoStreamer.c src/lib/annoStreamer.c index d86e111..837e417 100644 --- src/lib/annoStreamer.c +++ src/lib/annoStreamer.c @@ -1,133 +1,137 @@ /* annoStreamer -- returns items sorted by genomic position to successive nextRow calls */ #include "annoStreamer.h" #include "errabort.h" // ----------------------- annoStreamer base methods -------------------------- struct asObject *annoStreamerGetAutoSqlObject(struct annoStreamer *self) /* Return parsed autoSql definition of this streamer's data type. */ { return self->asObj; } void annoStreamerSetAutoSqlObject(struct annoStreamer *self, struct asObject *asObj) /* Use new asObj and update internal state derived from asObj. */ { annoFilterFreeList(&(self->filters)); self->asObj = asObj; self->filters = annoFiltersFromAsObject(asObj); self->numCols = slCount(asObj->columnList); } void annoStreamerSetRegion(struct annoStreamer *self, char *chrom, uint rStart, uint rEnd) /* Set genomic region for query; if chrom is NULL, position is genome. * Many subclasses should make their own setRegion method that calls this and * configures their data connection to change to the new position. */ { freez(&(self->chrom)); if (chrom == NULL) { self->positionIsGenome = TRUE; self->regionStart = self->regionEnd = 0; } else { self->positionIsGenome = FALSE; self->chrom = cloneString(chrom); self->regionStart = rStart; self->regionEnd = rEnd; } } static char *annoStreamerGetHeader(struct annoStreamer *self) /* Default method: return NULL. */ { return NULL; } struct annoFilter *annoStreamerGetFilters(struct annoStreamer *self) /* Return supported filters with current settings. Callers can modify and free when done. */ { return annoFilterCloneList(self->filters); } void annoStreamerSetFilters(struct annoStreamer *self, struct annoFilter *newFilters) /* Free old filters and use clone of newFilters. */ { annoFilterFreeList(&(self->filters)); self->filters = annoFilterCloneList(newFilters); } void annoStreamerInit(struct annoStreamer *self, struct annoAssembly *assembly, - struct asObject *asObj) + struct asObject *asObj, char *name) /* Initialize a newly allocated annoStreamer with default annoStreamer methods and * default filters and columns based on asObj. * In general, subclasses' constructors will call this first; override nextRow, close, * and probably setRegion; and then initialize their private data. */ { self->assembly = assembly; self->getAutoSqlObject = annoStreamerGetAutoSqlObject; self->setAutoSqlObject = annoStreamerSetAutoSqlObject; self->setRegion = annoStreamerSetRegion; self->getHeader = annoStreamerGetHeader; self->getFilters = annoStreamerGetFilters; self->setFilters = annoStreamerSetFilters; self->positionIsGenome = TRUE; self->setAutoSqlObject(self, asObj); +if (name == NULL) + errAbort("annoStreamerInit: need non-NULL name"); +self->name = cloneString(name); } void annoStreamerFree(struct annoStreamer **pSelf) /* Free self. This should be called at the end of subclass close methods, after * subclass-specific connections are closed and resources are freed. */ { if (pSelf == NULL) return; struct annoStreamer *self = *pSelf; +freez(&(self->name)); freez(&(self->chrom)); annoFilterFreeList(&(self->filters)); freez(pSelf); } INLINE boolean findColumn(struct asColumn *columns, char *name, int *retIx, char **retName) /* Scan columns for name. * If found, set retIx to column index, set retName to clone of name, and return TRUE. * If not found, set retIx to -1, set retName to NULL, and return FALSE; */ { int ix = asColumnFindIx(columns, name); if (retIx != NULL) *retIx = ix; if (retName != NULL) { if (ix >= 0) *retName = cloneString(name); else *retName = NULL; } return (ix >= 0); } boolean annoStreamerFindBed3Columns(struct annoStreamer *self, int *retChromIx, int *retStartIx, int *retEndIx, char **retChromField, char **retStartField, char **retEndField) /* Scan autoSql for recognized column names corresponding to BED3 columns. * Set ret*Ix to list index of each column if found, or -1 if not found. * Set ret*Field to column name if found, or NULL if not found. * If all three are found, return TRUE; otherwise return FALSE. */ { struct asColumn *columns = self->asObj->columnList; if (findColumn(columns, "chrom", retChromIx, retChromField)) { if (findColumn(columns, "chromStart", retStartIx, retStartField)) return findColumn(columns, "chromEnd", retEndIx, retEndField); else return (findColumn(columns, "txStart", retStartIx, retStartField) && findColumn(columns, "txEnd", retEndIx, retEndField)); } else if (findColumn(columns, "tName", retChromIx, retChromField)) return (findColumn(columns, "tStart", retStartIx, retStartField) && findColumn(columns, "tEnd", retEndIx, retEndField)); else if (findColumn(columns, "genoName", retChromIx, retChromField)) return (findColumn(columns, "genoStart", retStartIx, retStartField) && findColumn(columns, "genoEnd", retEndIx, retEndField)); return FALSE; }