Lucy::Plan::Schema – User-created specification for an inverted index.
A Schema is a specification which indicates how other entities should interpret the raw data in an inverted index and interact with it.
Once an actual index has been created using a particular Schema, existing field definitions may not be changed. However, it is possible to add new fields during subsequent indexing sessions.
lucy_Schema* // incremented lucy_Schema_new(void);
Constructor. Takes no arguments.
lucy_Schema* lucy_Schema_init( lucy_Schema *self );
Initialize a Schema.
lucy_Architecture* // incremented lucy_Schema_Architecture( lucy_Schema *self );
Factory method which creates an Architecture object for this index.
Define the behavior of a field by associating it with a FieldType.
If this method has already been called for the supplied
field, it will merely test to verify that the supplied
FieldType Equals() the existing one.
The name of the field.
Return the FieldType for the specified field. If the field can’t be found, return NULL.
lucy_Similarity* lucy_Schema_Fetch_Sim( lucy_Schema *self, cfish_String *field );
Return the Similarity for the specified field, or NULL if either the field can’t be found or it isn’t associated with a Similarity.
uint32_t lucy_Schema_Num_Fields( lucy_Schema *self );
Return the number of fields currently defined.
cfish_Vector* // incremented lucy_Schema_All_Fields( lucy_Schema *self );
Return all the Schema’s field names as an array.
lucy_Architecture* lucy_Schema_Get_Architecture( lucy_Schema *self );
Return the Schema instance’s internal Architecture object.
lucy_Similarity* lucy_Schema_Get_Similarity( lucy_Schema *self );
Return the Schema instance’s internal Similarity object.
Lucy::Plan::Schema is a Clownfish::Obj.
Copyright © 2010-2015 The Apache Software Foundation, Licensed under the
Apache License, Version 2.0.
Apache Lucy, Lucy, Apache, the Apache feather logo, and the Apache Lucy project logo are trademarks of The Apache Software Foundation. All other marks mentioned may be trademarks or registered trademarks of their respective owners.