Oracle Fusion Applications Search Java API Reference for Oracle Enterprise Crawl and Search Framework
11g Release 1 (11.1.2)

E21908-02

oracle.ecsf.impl.facet
Class Facet

java.lang.Object
  extended by oracle.ecsf.impl.facet.Facet
All Implemented Interfaces:
java.io.Serializable

public class Facet
extends java.lang.Object
implements java.io.Serializable

Represents a Facet.

See Also:
Serialized Form

Constructor Summary
Facet()
           
Facet(java.lang.String name, java.lang.String bindingName)
          Construct an empty facet with just a name.
 
Method Summary
 void filterEntries(java.util.Set<java.lang.String> values)
          Filter the entries to just the ones provided.
 java.lang.String getBindingName()
          Gets the binding name of the facet.
 java.lang.String getDisplayName()
          Gets the display name of the facet.
 FacetEntry[] getEntries()
          Gets the entries for this facet.
 java.lang.String getName()
          Gets the name of the facet.
 FacetEntry getParentEntry()
          Gets the parent facet entry.
 FacetPath getPath()
          Gets the path to this Facet.
 FacetEntry[] getPathEntries()
          Gets the FacetEntries that make up the path to this facet.
 java.lang.String getRootFacetName()
          Gets the name of the root facet that this facet belongs.
 boolean isLeaf()
          Returns whether this is the leaf facet in the hierarchy.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Facet

public Facet()

Facet

public Facet(java.lang.String name,
             java.lang.String bindingName)
Construct an empty facet with just a name.

Parameters:
name -
Method Detail

getName

public java.lang.String getName()
Gets the name of the facet.

Returns:

getDisplayName

public java.lang.String getDisplayName()
Gets the display name of the facet.

Returns:
String

getBindingName

public java.lang.String getBindingName()
Gets the binding name of the facet.

Returns:
String

getParentEntry

public FacetEntry getParentEntry()
Gets the parent facet entry.

Returns:
FacetEntry

getEntries

public FacetEntry[] getEntries()
Gets the entries for this facet.

Returns:
FacetEntry[]

getPath

public FacetPath getPath()
Gets the path to this Facet.

Returns:
FacetPath

getPathEntries

public FacetEntry[] getPathEntries()
Gets the FacetEntries that make up the path to this facet.

Returns:
FacetEntry[]

getRootFacetName

public java.lang.String getRootFacetName()
Gets the name of the root facet that this facet belongs.

Returns:
String

isLeaf

public boolean isLeaf()
Returns whether this is the leaf facet in the hierarchy.

Returns:
boolean

filterEntries

public void filterEntries(java.util.Set<java.lang.String> values)
Filter the entries to just the ones provided. Used to filter entries to ones with non-zero counts.

Parameters:
values - - map of entry value to null. the values to filter by.

Oracle Fusion Applications Search Java API Reference for Oracle Enterprise Crawl and Search Framework
11g Release 1 (11.1.2)

E21908-02

Copyright © 2011 Oracle. All rights reserved.