oracle.ecsf.meta.impl.facet
Class FacetDef

java.lang.Object
  oracle.ecsf.meta.impl.facet.FacetDef

All Implemented Interfaces:

java.io.Serializable

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

Represents a Facet Definition.

See Also:

Serialized Form

Constructor Summary

FacetDef()

Method Summary

java.lang.String	getBindingName() Gets the physical column binding of this facet.
java.lang.String	getDisplayName() Gets the display name.
FacetEntryDef	getEntryDef(java.lang.String value) Gets the child entry def that matches the value.
FacetEntryDef[]	getEntryDefs() Gets the entry defs.
java.lang.String	getFieldName() Gets the field that this facet is bound to.
java.util.Date	getLoadedTime() Returns the time when the entries were last attempted to be loaded.
java.lang.String	getName() Gets the name.
FacetEntryDef	getParentEntryDef() Gets the parent entry def, if one exists.
FacetSource	getSource() Gets the Facet source.
FacetDef	getSubFacetDef(java.lang.String[] values) Gets a sub-facet def that corresponds to the selected values.
boolean	isInvalid() Returns true if the facet entries were not able to be loaded.
boolean	isLeaf() Returns whether this is the leaf facet def.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FacetDef

public FacetDef()

Method Detail

getName

public java.lang.String getName()

Gets the name.

Returns:

String

getDisplayName

public java.lang.String getDisplayName()

Gets the display name.

Returns:

String

getFieldName

public java.lang.String getFieldName()

Gets the field that this facet is bound to.

Returns:

String

getBindingName

public java.lang.String getBindingName()

Gets the physical column binding of this facet.

Returns:

String

getEntryDefs

public FacetEntryDef[] getEntryDefs()

Gets the entry defs.

Returns:

FacetEntryDef[]

getParentEntryDef

public FacetEntryDef getParentEntryDef()

Gets the parent entry def, if one exists.

Returns:

FacetEntryDef - Returns the parent facet entry def, or null if none exists.

getSource

public FacetSource getSource()

Gets the Facet source.

Returns:

FacetSource

isInvalid

public boolean isInvalid()

Returns true if the facet entries were not able to be loaded.

Returns:

boolean

getLoadedTime

public java.util.Date getLoadedTime()

Returns the time when the entries were last attempted to be loaded.

Returns:

Date

getSubFacetDef

public FacetDef getSubFacetDef(java.lang.String[] values)
                        throws SearchException

Gets a sub-facet def that corresponds to the selected values.

Parameters:

values - - the values selected for this facet and child facets.

Returns:

FacetDef - Returns the sub-facet.

Throws:

java.lang.Exception

SearchException

getEntryDef

public FacetEntryDef getEntryDef(java.lang.String value)

Gets the child entry def that matches the value.

Parameters:

value - - the value to look for.

Returns:

FacetEntryDef - the entry that matches the value.

isLeaf

public boolean isLeaf()

Returns whether this is the leaf facet def.

Returns:

boolean