xref: /aosp_15_r20/external/icing/icing/transform/normalizer-factory.h (revision 8b6cd535a057e39b3b86660c4aa06c99747c2136)
1 // Copyright (C) 2019 Google LLC
2 //
3 // Licensed under the Apache License, Version 2.0 (the "License");
4 // you may not use this file except in compliance with the License.
5 // You may obtain a copy of the License at
6 //
7 //      http://www.apache.org/licenses/LICENSE-2.0
8 //
9 // Unless required by applicable law or agreed to in writing, software
10 // distributed under the License is distributed on an "AS IS" BASIS,
11 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 // See the License for the specific language governing permissions and
13 // limitations under the License.
14 
15 #ifndef ICING_TRANSFORM_NORMALIZER_FACTORY_H_
16 #define ICING_TRANSFORM_NORMALIZER_FACTORY_H_
17 
18 #include <memory>
19 
20 #include "icing/text_classifier/lib3/utils/base/statusor.h"
21 #include "icing/absl_ports/canonical_errors.h"
22 #include "icing/transform/normalizer.h"
23 
24 namespace icing {
25 namespace lib {
26 
27 namespace normalizer_factory {
28 
29 // Creates a normalizer. max_term_byte_size enforces the max size of text after
30 // normalization, text will be truncated if exceeds the max size.
31 //
32 // Returns:
33 //   A normalizer on success
34 //   INVALID_ARGUMENT if max_term_byte_size <= 0
35 //   INTERNAL_ERROR on errors
36 libtextclassifier3::StatusOr<std::unique_ptr<Normalizer>> Create(
37     int max_term_byte_size);
38 
39 }  // namespace normalizer_factory
40 
41 }  // namespace lib
42 }  // namespace icing
43 
44 #endif  // ICING_TRANSFORM_NORMALIZER_FACTORY_H_
45