Java Doc for Property.java in » Search-Engine » compass-2.0 » org » compass » core » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation

1.	6.0 JDK Core
2.	6.0 JDK Modules
3.	6.0 JDK Modules com.sun
4.	6.0 JDK Modules com.sun.java
5.	6.0 JDK Modules sun
6.	6.0 JDK Platform
7.	Ajax
8.	Apache Harmony Java SE
9.	Aspect oriented
10.	Authentication Authorization
11.	Blogger System
12.	Build
13.	Byte Code
14.	Cache
15.	Chart
16.	Chat
17.	Code Analyzer
18.	Collaboration
19.	Content Management System
20.	Database Client
21.	Database DBMS
22.	Database JDBC Connection Pool
23.	Database ORM
24.	Development
25.	EJB Server geronimo
26.	EJB Server GlassFish
27.	EJB Server JBoss 4.2.1
28.	EJB Server resin 3.1.5
29.	ERP CRM Financial
30.	ESB
31.	Forum
32.	GIS
33.	Graphic Library
34.	Groupware
35.	HTML Parser
36.	IDE
37.	IDE Eclipse
38.	IDE Netbeans
39.	Installer
40.	Internationalization Localization
41.	Inversion of Control
42.	Issue Tracking
43.	J2EE
44.	JBoss
45.	JMS
46.	JMX
47.	Library
48.	Mail Clients
49.	Net
50.	Parser
51.	PDF
52.	Portal
53.	Profiler
54.	Project Management
55.	Report
56.	RSS RDF
57.	Rule Engine
58.	Science
59.	Scripting
60.	Search Engine
61.	Security
62.	Sevlet Container
63.	Source Control
64.	Swing Library
65.	Template Engine
66.	Test Coverage
67.	Testing
68.	UML
69.	Web Crawler
70.	Web Framework
71.	Web Mail
72.	Web Server
73.	Web Services
74.	Web Services apache cxf 2.0.1
75.	Web Services AXIS2
76.	Wiki Engine
77.	Workflow Engines
78.	XML
79.	XML UI

Java

Java Tutorial

Illustrator Tutorials

GIMP Tutorials

C# / C Sharp

C# / CSharp Tutorial

C# / CSharp Open Source

SQL Server / T-SQL Tutorial

Oracle PL / SQL

Oracle PL/SQL Tutorial

Flash / Flex / ActionScript

VBA / Excel / Access / Word

XML

XML Tutorial

Microsoft Office PowerPoint 2007 Tutorial

Microsoft Office Excel 2007 Tutorial

Microsoft Office Word 2007 Tutorial

Java Source Code / Java Documentation » Search Engine » compass 2.0 » org.compass.core

Source Cross Reference Class Diagram Java Document (Java Doc)

org.compass.core .Property

Property

public interface Property extends Serializable(Code)

The basic Compass meta data holder. A property is a name value pair representing the mapped object attribute and value. Can be used to fetch meta data values from a resource in an abstract way.

As an example:

 resource.getProperty("authorName").getStringValue();

Note that there are internal properties (that compass uses for the marshlling of objects) and meta data properties.

author:
kimchy

Inner Class :final public static class Store extends Parameter

Inner Class :final public static class Index extends Parameter

Inner Class :final public static class TermVector extends Parameter

Method Summary
byte[]	getBinaryValue() Returns the binary values of the property.
float	getBoost() Returns the boost for the property.
String	getName() Returns the name of the property.
Object	getObjectValue() Returns the object value of the property.
String	getStringValue() Returns the string value of the proerty.
boolean	isBinary()
boolean	isCompressed()
boolean	isIndexed() True iff the value of the field is to be indexed, so that it may be searched on.
boolean	isOmitNorms() Expert: If set, omit normalization factors associated with this indexed field.
boolean	isStored() True iff the value of the field is to be stored in the index for return with search hits.
boolean	isTermVectorStored() True iff the term or terms used to index this field are stored as a term vector, available from TODO.
boolean	isTokenized() True iff the value of the field should be tokenized as text prior to indexing.
void	setBoost(float boost) Sets the boost level for the property.
void	setOmitNorms(boolean omitNorms) Expert: If set, omit normalization factors associated with this indexed field.

Method Detail

getBinaryValue
byte[] getBinaryValue()(Code)
	Returns the binary values of the property. Only valid if `isBinary` is true. the binary value

getBoost
float getBoost()(Code)
	Returns the boost for the property. the boost value

getName
String getName()(Code)
	Returns the name of the property. the name of the property

getObjectValue
Object getObjectValue()(Code)
	Returns the object value of the property. If a converter is associated with the property in one of Compass mapping definitions, it will be used to convert the string value to an object value. If there is no converter associated with the property, the string value will be returned. The converted object value

getStringValue
String getStringValue()(Code)
	Returns the string value of the proerty. the string value

isBinary
boolean isBinary()(Code)
	True iff the value of the filed is stored as binary

isCompressed
boolean isCompressed()(Code)
	True if the value of the field is stored and compressed within the index

isIndexed
boolean isIndexed()(Code)
	True iff the value of the field is to be indexed, so that it may be searched on.

isOmitNorms
boolean isOmitNorms()(Code)
	Expert: If set, omit normalization factors associated with this indexed field. This effectively disables indexing boosts and length normalization for this field.

isStored
boolean isStored()(Code)
	True iff the value of the field is to be stored in the index for return with search hits. It is an error for this to be true if a field is Reader-valued.

isTermVectorStored
boolean isTermVectorStored()(Code)
	True iff the term or terms used to index this field are stored as a term vector, available from TODO. These methods do not provide access to the original content of the field, only to terms used to index it. If the original content must be preserved, use the `stored` attribute instead.

isTokenized
boolean isTokenized()(Code)
	True iff the value of the field should be tokenized as text prior to indexing. Un-tokenized fields are indexed as a single word and may not be Reader-valued.

setBoost
void setBoost(float boost)(Code)
	Sets the boost level for the property. The boost value can be specified in the mapping file to influence the order of search results. Parameters: boost -

setOmitNorms
void setOmitNorms(boolean omitNorms)(Code)
	Expert: If set, omit normalization factors associated with this indexed field. This effectively disables indexing boosts and length normalization for this field.

www.java2java.com | Contact Us

All other trademarks are property of their respective owners.