/usr/include/GNUstep/Frameworks/BioCocoa.framework/Versions/2/BCAnnotation.h is in libbiococoa-dev 2.2.2-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 | //
// BCAnnotation.h
// BioCocoa
//
// Created by Alexander Griekspoor on 22/2/2005.
// Copyright (c) 2003-2009 The BioCocoa Project.
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions
// are met:
// 1. Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
// 2. Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
// 3. The name of the author may not be used to endorse or promote products
// derived from this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
// IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
// OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
// IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
// INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
// NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
// THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
/*!
@header
@abstract Provides sequence annotations.
*/
#import <Foundation/Foundation.h>
#import "BCFoundationDefines.h"
// BCAnnotation Strings
/*!
@constant BCAnnotationIdentity
@abstract Annotation Identity Property
*/
extern NSString * const BCAnnotationIdentity;
/*!
@constant BCAnnotationOrganism
@abstract Annotation Organism Property
*/
extern NSString * const BCAnnotationOrganism;
/*!
@class BCAnnotation
@abstract Represents a single annotation belonging to a sequence
@discussion This class represents a non-positional annotation (in contrast to its subclass BCFeature which adds positional information).
* BCAnnotation objects are held by the sequence object in a mutable dictionary with its name as the key. Each annotation object
* has a name (as its identifier), and a content which can be of any class but must be an object. The name of the content class is
* can be retrieved using the datatype method. These property names (name, content, datatype) adhere to the BSML standard of attributes.
* Note that in principle it is possible to store arrays and dictionaries as content, which allows for nested annotations. Further
* methods to support/organize annotation nesting/sets are necessary though, nesting is therefore not advised.
*/
@interface BCAnnotation : NSObject <NSCopying>{
NSString *name; // name or identifier of the annotation
NSObject *content; // content, must be an object (plain c types must be converted to NSNumber)
}
#if 0
#pragma mark == INITIALIZATION METHODS ==
#endif
/*!
@method initWithName:content:
@abstract initializes a BCAnnotation object by passing it a NSString (name) and content object.
@discussion This is the designated initializer for BCAnnotation
*/
- (id)initWithName: (NSString *)aName content: (id)theContent;
/*!
@method initWithName:intValue:
@abstract initializes a BCAnnotation object by passing it a NSString name and integer as content.
@discussion This is method converts an integer in a NSNumber object and uses the designated initializer
* to initialize a BCAnnotation object
*/
- (id)initWithName: (NSString *)aName intValue: (int)theContent;
/*!
@method initWithName:floatValue:
@abstract initializes a BCAnnotation object by passing it a NSString name and float as content.
@discussion This is method converts a float in a NSNumber object and uses the designated initializer
* to initialize a BCAnnotation object
*/
- (id)initWithName: (NSString *)aName floatValue: (float)theContent;
/*!
@method initWithName:doubleValue:
@abstract initializes a BCAnnotation object by passing it a NSString name and double as content.
@discussion This is method converts a double in a NSNumber object and uses the designated initializer
* to initialize a BCAnnotation object
*/
- (id)initWithName: (NSString *)aName doubleValue: (double)theContent;
/*!
@method initWithName:boolValue:
@abstract initializes a BCAnnotation object by passing it a NSString name and boolean as content.
@discussion This is method converts a boolean in a NSNumber object and uses the designated initializer
* to initialize a BCAnnotation object
*/
- (id)initWithName: (NSString *)aName boolValue: (BOOL)theContent;
/*!
@method annotationWithName:content:
@abstract creates and returns an autoreleased annotation object initialized with a NSString (name) and content object.
*/
+ (id)annotationWithName: (NSString *)aName content: (id)theContent;
/*!
@method annotationWithName:intValue:
@abstract creates and returns an autoreleased annotation object initialized with a NSString (name) and integer as content.
@discussion This is method converts a integer in a NSNumber object
*/
+ (id)annotationWithName: (NSString *)aName intValue: (int)theContent;
/*!
@method annotationWithName:floatValue:
@abstract creates and returns an autoreleased annotation object initialized with a NSString (name) and float as content.
@discussion This is method converts a float in a NSNumber object
*/
+ (id)annotationWithName: (NSString *)aName floatValue: (float)theContent;
/*!
@method annotationWithName:doubleValue:
@abstract creates and returns an autoreleased annotation object initialized with a NSString (name) and double as content.
@discussion This is method converts a double in a NSNumber object
*/
+ (id)annotationWithName: (NSString *)aName doubleValue: (double)theContent;
/*!
@method annotationWithName:boolValue:
@abstract creates and returns an autoreleased annotation object initialized with a NSString (name) and boolean as content.
@discussion This is method converts a boolean in a NSNumber object
*/
+ (id)annotationWithName: (NSString *)aName boolValue: (BOOL)theContent;
/*!
@method copyWithZone:
@abstract returns copy of the receiving annotation object.
*/
- (id)copyWithZone:(NSZone *)zone;
#if 0
#pragma mark == ACCESSOR METHODS ==
#endif
/*!
@method name
@abstract returns the name of the annotation
*/
- (NSString *)name;
/*!
@method setName:
@abstract sets the name of the annotation
*/
- (void)setName:(NSString *)newName;
/*!
@method content
@abstract returns the name of the content
*/
- (NSObject *)content;
/*!
@method setContent:
@abstract sets the content of the annotation
@discussion Note that this method retains the content object!
*/
- (void)setContent:(NSObject *)newContent;
#if 0
#pragma mark == GENERAL METHODS ==
#endif
/*!
@method description
@abstract returns the name, content, and datatype
*/
- (NSString *) description;
/*!
@method datatype
@abstract returns the class name of the content object
*/
- (NSString *)datatype;
/*!
@method stringValue
@abstract returns a string representation of the content object
@discussion If the content object is not of class NSString this method returns the content object's description
*/
- (NSString *) stringValue;
/*!
@method intValue
@abstract returns an integer representation of the content object
@discussion This method tries to call intValue on the content object. Otherwise returns 0.
*/
- (int)intValue;
/*!
@method floatValue
@abstract returns an float representation of the content object
@discussion This method tries to call floatValue on the content object. Otherwise returns 0.0.
*/
- (float)floatValue;
/*!
@method doubleValue
@abstract returns an double representation of the content object
@discussion This method tries to call doubleValue on the content object. Otherwise returns 0.0.
*/
- (double)doubleValue;
/*!
@method boolValue
@abstract returns an bool representation of the content object
@discussion This method tries to call boolValue on the content object. Otherwise returns NO.
*/
- (BOOL)boolValue;
#if 0
#pragma mark == COMPARISON & SORTING METHODS ==
#endif
/*!
@method isEqualTo:
@abstract Compares the receiving annotation to otherAnnotation.
@discussion If the NAME of otherAnnotation is equal to that of the receiver, this method returns YES. If not, it returns NO.
*/
- (BOOL)isEqualTo: (BCAnnotation *) otherAnnotation;
/*!
@method isEqualToAnnotation:
@abstract Compares the content of the receiving annotation to otherAnnotation.
@discussion If the CONTENT of otherAnnotation is equal to that of the receiver, this method returns YES. If not, it returns NO.
* Note that the names of both annotations do not necessarily have to be identical.
*/
- (BOOL)isEqualToAnnotation: (BCAnnotation *) otherAnnotation;
/*!
@method sortAnnotationsOnNameAscending:
@abstract Sorts the receiving annotations compared to otherAnnotation based on name in ascending order.
*/
- (NSComparisonResult)sortAnnotationsOnNameAscending:(BCAnnotation *) ann;
/*!
@method sortAnnotationsOnNameDescending:
@abstract Sorts the receiving annotations compared to otherAnnotation based on name in descending order.
*/
- (NSComparisonResult)sortAnnotationsOnNameDescending:(BCAnnotation *) ann;
/*!
@method sortAnnotationsOnContentAscending:
@abstract Sorts the receiving annotations compared to otherAnnotation based on content in ascending order.
@discussion If both contents are of class NSString OR NSNumber calls compare: else returns NSOrderedSame
*/
- (NSComparisonResult)sortAnnotationsOnContentAscending:(BCAnnotation *) ann;
/*!
@method sortAnnotationsOnContentDescending:
@abstract Sorts the receiving annotations compared to otherAnnotation based on content in descending order.
@discussion If both contents are of class NSString OR NSNumber calls compare: else returns NSOrderedSame
*/
- (NSComparisonResult)sortAnnotationsOnContentDescending:(BCAnnotation *) ann;
@end
|