[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-03 UTC."],[[["\u003cp\u003e\u003ccode\u003eFacetRefinement\u003c/code\u003e is used to filter search results based on a specific facet value, allowing for the creation of refined queries.\u003c/p\u003e\n"],["\u003cp\u003eIt is recommended to use refinement token strings provided by \u003ccode\u003eFacetResultValue\u003c/code\u003e instead of manually creating \u003ccode\u003eFacetRefinement\u003c/code\u003e objects.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eFacetRefinement\u003c/code\u003e can be created using \u003ccode\u003ewithRange\u003c/code\u003e for numeric facets or \u003ccode\u003ewithValue\u003c/code\u003e for specific facet values, and they can be converted to token strings for use in follow up queries.\u003c/p\u003e\n"],["\u003cp\u003eYou can also use the \u003ccode\u003efromTokenString\u003c/code\u003e static method to create a \u003ccode\u003eFacetRefinement\u003c/code\u003e object from a token string.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eFacetRefinement\u003c/code\u003e class is used in conjunction with the \u003ccode\u003eQuery.Builder\u003c/code\u003e to filter results based on facet values, and its \u003ccode\u003egetName\u003c/code\u003e, \u003ccode\u003egetRange\u003c/code\u003e, and \u003ccode\u003egetValue\u003c/code\u003e methods allow you to retrieve the facet name, range, and value, respectively.\u003c/p\u003e\n"]]],[],null,["# Class FacetRefinement (2.0.0)\n\n public final class FacetRefinement\n\nA Facet Refinement to filter out search results based on a facet value.\n\n\nWe recommend using refinement token strings instead of this class. We include a refinement\ntoken string with each [FacetResultValue](/appengine/docs/standard/java-gen2/reference/services/bundled/latest/com.google.appengine.api.search.FacetResultValue) returned by the backend that can be passed to\n[Query.Builder#addFacetRefinementFromToken(String)](/appengine/docs/standard/java-gen2/reference/services/bundled/latest/com.google.appengine.api.search.Query.Builder#com_google_appengine_api_search_Query_Builder_addFacetRefinementFromToken_java_lang_String_) to refine follow-up queries.\n\n\nWe also support manually-specified query refinements by passing an instance of this class to\n[Query.Builder#addFacetRefinement(FacetRefinement)](/appengine/docs/standard/java-gen2/reference/services/bundled/latest/com.google.appengine.api.search.Query.Builder#com_google_appengine_api_search_Query_Builder_addFacetRefinement_com_google_appengine_api_search_FacetRefinement_).\n\n\nExample: Request to only return documents that have a number facet named \"rating\" with a value\nbetween one and two: \n\n\n FacetRefinement lowRating = FacetRefinement.withRange(\"rating\", FacetRange.startEnd(1.0, 2.0));\n query.addFacetRefinement(lowRating);\n \nInheritance\n-----------\n\n[java.lang.Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html) \\\u003e FacetRefinement \n\nInherited Members\n-----------------\n\n[Object.clone()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--) \n[Object.equals(Object)](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-) \n[Object.finalize()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--) \n[Object.getClass()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--) \n[Object.hashCode()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--) \n[Object.notify()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--) \n[Object.notifyAll()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--) \n[Object.toString()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--) \n[Object.wait()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--) \n[Object.wait(long)](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-) \n[Object.wait(long,int)](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-)\n\nStatic Methods\n--------------\n\n### fromTokenString(String token)\n\n public static FacetRefinement fromTokenString(String token)\n\nConverts a token string to a FacetRefinement object.\n\n\nNOTE: Do not persist token strings. The format may change.\n\n### withRange(String name, FacetRange range)\n\n public static FacetRefinement withRange(String name, FacetRange range)\n\nCreate a [FacetRefinement](/appengine/docs/standard/java-gen2/reference/services/bundled/latest/com.google.appengine.api.search.FacetRefinement) with the given `name` and `range`.\n\n### withValue(String name, String value)\n\n public static FacetRefinement withValue(String name, String value)\n\nCreate a [FacetRefinement](/appengine/docs/standard/java-gen2/reference/services/bundled/latest/com.google.appengine.api.search.FacetRefinement) with the given `name` and `value`.\n\nMethods\n-------\n\n### getName()\n\n public String getName()\n\nReturns the name of the facet.\n\n### getRange()\n\n public FacetRange getRange()\n\nReturns the range for numeric facets or null if there is no range.\n\n### getValue()\n\n public String getValue()\n\nReturns the value of the facet or null if there is no value.\n\n### toString()\n\n public String toString()\n\n**Overrides** \n[Object.toString()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--)\n\n### toTokenString()\n\n public String toTokenString()\n\nConverts this refinement to a token string safe to be used in HTML.\n\n\nNOTE: Do not persist token strings. The format may change."]]
