fcb_core 0.7.6

FlatCityBuf is a library for reading and writing CityJSON with FlatBuffers. Contains code derived from FlatGeobuf (BSD-2-Clause) for spatial indexing.
Documentation
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
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
use anyhow::Result;
use cjseq::CityJSONFeature;
use fcb_core::{
    attribute::{AttributeSchema, AttributeSchemaMethods},
    header_writer::HeaderWriterOptions,
    read_cityjson_from_reader, CJType, CJTypeKind, FcbReader, FcbWriter, Operator,
};
use std::{
    fs::File,
    io::{BufReader, Cursor, Seek, SeekFrom},
    path::PathBuf,
};

#[cfg(test)]
mod tests {
    use std::str::FromStr;

    use super::*;
    use fcb_core::{FixedStringKey, Float, KeyType};
    use pretty_assertions::assert_eq;

    #[test]
    fn test_attr_index() -> Result<()> {
        // Setup paths
        let manifest_dir = PathBuf::from(env!("CARGO_MANIFEST_DIR"));
        let input_file = manifest_dir
            .join("tests")
            .join("data")
            .join("small.city.jsonl");

        // Read original CityJSONSeq
        let input_file = File::open(input_file)?;
        let input_reader = BufReader::new(input_file);
        let original_cj_seq = match read_cityjson_from_reader(input_reader, CJTypeKind::Seq)? {
            CJType::Seq(seq) => seq,
            _ => panic!("Expected CityJSONSeq"),
        };

        // Write to FCB

        let mut memory_buffer = Cursor::new(Vec::new());
        let mut attr_schema = AttributeSchema::new();
        for feature in original_cj_seq.features.iter() {
            for (_, co) in feature.city_objects.iter() {
                if let Some(attributes) = &co.attributes {
                    attr_schema.add_attributes(attributes);
                }
            }
        }
        let attr_indices = vec![
            ("b3_h_dak_50p".to_string(), None),
            ("identificatie".to_string(), None),
        ];
        let mut fcb = FcbWriter::new(
            original_cj_seq.cj.clone(),
            Some(HeaderWriterOptions {
                write_index: true,
                feature_count: original_cj_seq.features.len() as u64,
                index_node_size: 16,
                attribute_indices: Some(attr_indices),
                geographical_extent: None,
            }),
            Some(attr_schema),
            None,
        )?;
        for feature in original_cj_seq.features.iter() {
            fcb.add_feature(feature)?;
        }
        fcb.write(&mut memory_buffer)?;

        let query: Vec<(String, Operator, KeyType)> = vec![
            (
                "b3_h_dak_50p".to_string(),
                Operator::Gt,
                KeyType::Float64(Float(2.0)),
            ),
            (
                "identificatie".to_string(),
                Operator::Eq,
                KeyType::StringKey50(FixedStringKey::from_str("NL.IMBAG.Pand.0503100000012869")),
            ),
        ];
        memory_buffer.seek(std::io::SeekFrom::Start(0))?;

        let mut reader = FcbReader::open(memory_buffer)?.select_attr_query(query)?;

        let header = reader.header();
        let mut deserialized_features = Vec::new();
        let feat_count = header.features_count();
        let mut feat_num = 0;
        while let Ok(Some(feat_buf)) = reader.next() {
            let feature = feat_buf.cur_cj_feature()?;
            deserialized_features.push(feature);
            feat_num += 1;
            if feat_num >= feat_count {
                break;
            }
        }
        assert_eq!(deserialized_features.len(), 1);
        let feature = deserialized_features.first().unwrap();
        let mut contains_b3_h_dak_50p = false;
        let mut contains_identificatie = false;
        for co in feature.city_objects.values() {
            if co.attributes.is_some() {
                let attrs = co.attributes.as_ref().unwrap();
                if let Some(b3_h_dak_50p) = attrs.get("b3_h_dak_50p") {
                    if b3_h_dak_50p.as_f64().unwrap() > 2.0 {
                        contains_b3_h_dak_50p = true;
                    }
                }
                if let Some(identificatie) = attrs.get("identificatie") {
                    if identificatie.as_str().unwrap() == "NL.IMBAG.Pand.0503100000012869" {
                        contains_identificatie = true;
                    }
                }
            }
        }
        assert!(contains_b3_h_dak_50p);
        assert!(contains_identificatie);

        Ok(())
    }

    #[test]
    fn test_attr_index_seq() -> Result<()> {
        // Setup paths
        let manifest_dir = PathBuf::from(env!("CARGO_MANIFEST_DIR"));
        let input_file = manifest_dir
            .join("tests")
            .join("data")
            .join("small.city.jsonl");

        // Read original CityJSONSeq
        let input_file = File::open(input_file)?;
        let input_reader = BufReader::new(input_file);
        let original_cj_seq = match read_cityjson_from_reader(input_reader, CJTypeKind::Seq)? {
            CJType::Seq(seq) => seq,
            _ => panic!("Expected CityJSONSeq"),
        };

        // Write to FCB

        let mut memory_buffer = Cursor::new(Vec::new());

        let mut attr_schema = AttributeSchema::new();
        for feature in original_cj_seq.features.iter() {
            for (_, co) in feature.city_objects.iter() {
                if let Some(attributes) = &co.attributes {
                    attr_schema.add_attributes(attributes);
                }
            }
        }
        let attr_indices = vec![
            ("b3_h_dak_50p".to_string(), None),
            ("identificatie".to_string(), None),
        ];
        let mut fcb = FcbWriter::new(
            original_cj_seq.cj.clone(),
            Some(HeaderWriterOptions {
                write_index: true,
                feature_count: original_cj_seq.features.len() as u64,
                index_node_size: 16,
                attribute_indices: Some(attr_indices),
                geographical_extent: None,
            }),
            Some(attr_schema),
            None,
        )?;
        for feature in original_cj_seq.features.iter() {
            fcb.add_feature(feature)?;
        }
        fcb.write(&mut memory_buffer)?;

        let query: Vec<(String, Operator, KeyType)> = vec![
            (
                "b3_h_dak_50p".to_string(),
                Operator::Gt,
                KeyType::Float64(Float(2.0)),
            ),
            (
                "identificatie".to_string(),
                Operator::Eq,
                KeyType::StringKey50(FixedStringKey::from_str("NL.IMBAG.Pand.0503100000012869")),
            ),
        ];
        memory_buffer.seek(std::io::SeekFrom::Start(0))?;
        let mut reader = FcbReader::open(memory_buffer)?.select_attr_query_seq(query)?;

        let header = reader.header();
        let mut deserialized_features = Vec::new();
        let feat_count = header.features_count();
        let mut feat_num = 0;
        while let Ok(Some(feat_buf)) = reader.next() {
            let feature = feat_buf.cur_cj_feature()?;
            deserialized_features.push(feature);
            feat_num += 1;
            if feat_num >= feat_count {
                break;
            }
        }
        assert_eq!(deserialized_features.len(), 1);
        let feature = deserialized_features.first().unwrap();
        let mut contains_b3_h_dak_50p = false;
        let mut contains_identificatie = false;
        for co in feature.city_objects.values() {
            if co.attributes.is_some() {
                let attrs = co.attributes.as_ref().unwrap();
                if let Some(b3_h_dak_50p) = attrs.get("b3_h_dak_50p") {
                    if b3_h_dak_50p.as_f64().unwrap() > 2.0 {
                        contains_b3_h_dak_50p = true;
                    }
                }
                if let Some(identificatie) = attrs.get("identificatie") {
                    if identificatie.as_str().unwrap() == "NL.IMBAG.Pand.0503100000012869" {
                        contains_identificatie = true;
                    }
                }
            }
        }
        assert!(contains_b3_h_dak_50p);
        assert!(contains_identificatie);

        Ok(())
    }

    #[test]
    fn test_attr_index_multiple_queries() -> Result<()> {
        // --- Prepare FCB data ---
        let manifest_dir = PathBuf::from(env!("CARGO_MANIFEST_DIR"));
        let input_file = manifest_dir
            .join("tests")
            .join("data")
            .join("small.city.jsonl");

        let input_file = File::open(input_file)?;
        let input_reader = BufReader::new(input_file);
        let original_cj_seq = match read_cityjson_from_reader(input_reader, CJTypeKind::Seq)? {
            CJType::Seq(seq) => seq,
            _ => panic!("Expected CityJSONSeq"),
        };

        // Build attribute schema from features.
        let mut attr_schema = AttributeSchema::new();
        for feature in original_cj_seq.features.iter() {
            for (_, co) in feature.city_objects.iter() {
                if let Some(attributes) = &co.attributes {
                    attr_schema.add_attributes(attributes);
                }
            }
        }
        let attr_indices = vec![
            ("b3_h_dak_50p".to_string(), None),
            ("identificatie".to_string(), None),
            ("tijdstipregistratie".to_string(), None),
        ];
        let mut fcb = FcbWriter::new(
            original_cj_seq.cj.clone(),
            Some(HeaderWriterOptions {
                write_index: true,
                feature_count: original_cj_seq.features.len() as u64,
                index_node_size: 16,
                attribute_indices: Some(attr_indices),
                geographical_extent: None,
            }),
            Some(attr_schema),
            None,
        )?;
        for feature in original_cj_seq.features.iter() {
            fcb.add_feature(feature)?;
        }
        let mut memory_buffer = Cursor::new(Vec::new());
        fcb.write(&mut memory_buffer)?;
        // Clone the underlying byte vector to re-create a fresh Cursor for every test case.
        let fcb_data = memory_buffer.get_ref().clone();

        // --- Helper: Run a query test ---
        fn run_query_test(
            data: &[u8],
            query: &Vec<(String, Operator, KeyType)>,
        ) -> Result<Vec<CityJSONFeature>> {
            // Create a new Cursor from the data.
            let mut cursor = Cursor::new(data.to_vec());
            cursor.seek(SeekFrom::Start(0))?;
            let mut reader = FcbReader::open(cursor)?.select_attr_query(query.clone())?;
            let feat_count = reader.header().features_count();
            let mut features = Vec::new();
            let mut feat_num = 0;
            while let Ok(Some(feat_buf)) = reader.next() {
                let feature = feat_buf.cur_cj_feature()?;
                features.push(feature);
                feat_num += 1;
                if feat_num >= feat_count {
                    break;
                }
            }
            Ok(features)
        }

        // --- Define Test Cases ---
        #[derive(Debug)]
        struct QueryTestCase {
            test_name: &'static str,
            query: Vec<(String, Operator, KeyType)>,
            expected_count: usize,
            /// A validator function that returns true if the feature satisfies expected conditions.
            validator: fn(&CityJSONFeature) -> bool,
        }

        let test_cases = vec![
            // Test case: Expect one matching feature with b3_h_dak_50p > 2.0 and matching identificatie.
            QueryTestCase {
                test_name: "test_attr_index_multiple_queries: b3_h_dak_50p > 2.0 and identificatie == NL.IMBAG.Pand.0503100000012869",
                query: vec![
                    (
                        "b3_h_dak_50p".to_string(),
                        Operator::Gt,
                        KeyType::Float64(Float(2.0)),
                    ),
                    (
                        "identificatie".to_string(),
                        Operator::Eq,
                        KeyType::StringKey50(FixedStringKey::from_str(
                            "NL.IMBAG.Pand.0503100000012869",
                        )),
                    ),
                ],
                expected_count: 1,
                validator: |feature: &CityJSONFeature| {
                    let mut valid_b3 = false;
                    let mut valid_ident = false;
                    for co in feature.city_objects.values() {
                        if let Some(attrs) = &co.attributes {
                            if let Some(val) = attrs.get("b3_h_dak_50p") {
                                if val.as_f64().unwrap() > 2.0 {
                                    valid_b3 = true;
                                }
                            }
                            if let Some(ident) = attrs.get("identificatie") {
                                if ident.as_str().unwrap() == "NL.IMBAG.Pand.0503100000012869" {
                                    valid_ident = true;
                                }
                            }
                        }
                    }
                    valid_b3 && valid_ident
                },
            },
            // Test case: Expect zero features where tijdstipregistratie is before 2008-01-01.
            QueryTestCase {
                test_name: "test_attr_index_multiple_queries: tijdstipregistratie < 2008-01-01",
                query: vec![(
                    "tijdstipregistratie".to_string(),
                    Operator::Lt,
                    KeyType::DateTime(chrono::DateTime::<chrono::Utc>::from_str(
                        "2008-01-01T00:00:00Z",
                    )?),
                )],
                expected_count: 0,
                validator: |feature: &CityJSONFeature| {
                    let mut valid_tijdstip = true;
                    let query_tijdstip = chrono::NaiveDate::from_ymd(2008, 1, 1).and_hms(0, 0, 0);
                    for co in feature.city_objects.values() {
                        if let Some(attrs) = &co.attributes {
                            if let Some(val) = attrs.get("tijdstipregistratie") {
                                let val_tijdstip = chrono::NaiveDateTime::parse_from_str(
                                    val.as_str().unwrap(),
                                    "%Y-%m-%dT%H:%M:%S",
                                )
                                .unwrap();
                                if val_tijdstip < query_tijdstip {
                                    valid_tijdstip = false;
                                }
                            }
                        }
                    }
                    valid_tijdstip
                },
            },
            // // Test case: Expect zero features where tijdstipregistratie is after 2008-01-01.
            QueryTestCase {
                test_name: "test_attr_index_multiple_queries: tijdstipregistratie > 2008-01-01",
                query: vec![(
                    "tijdstipregistratie".to_string(),
                    Operator::Gt,
                    KeyType::DateTime(chrono::DateTime::<chrono::Utc>::from_utc(
                        chrono::NaiveDate::from_ymd(2008, 1, 1).and_hms(0, 0, 0),
                        chrono::Utc,
                    )),
                )],
                expected_count: 3,
                validator: |feature: &CityJSONFeature| {
                    let mut valid_tijdstip = false;
                    let query_tijdstip = chrono::NaiveDate::from_ymd(2008, 1, 1).and_hms(0, 0, 0);
                    for co in feature.city_objects.values() {
                        if let Some(attrs) = &co.attributes {
                            if let Some(val) = attrs.get("tijdstipregistratie") {
                                let val_tijdstip =
                                    chrono::DateTime::parse_from_rfc3339(val.as_str().unwrap())
                                        .map_err(|e| eprintln!("Failed to parse datetime: {e}"))
                                        .map(|dt| dt.naive_utc())
                                        .unwrap_or_else(|_| {
                                            chrono::NaiveDateTime::from_timestamp_opt(0, 0).unwrap()
                                        });
                                if val_tijdstip > query_tijdstip {
                                    valid_tijdstip = true;
                                }
                            }
                        }
                    }
                    valid_tijdstip
                },
            },
        ];

        // --- Run Test Cases ---
        for test_case in test_cases.into_iter() {
            let features = run_query_test(&fcb_data, &test_case.query)?;
            println!("running test: {}", test_case.test_name);
            assert_eq!(
                features.len(),
                test_case.expected_count,
                "Unexpected feature count for query: {:?}",
                test_case.query
            );
            for feature in features {
                assert!(
                    (test_case.validator)(&feature),
                    "Validator failed for feature: {feature:?}"
                );
            }
        }
        Ok(())
    }
}