Hibernate SVN: r15633 - validator/trunk/validation-api/src/test/java/org/hibernate/validator/spec/s2/s4.
by hibernate-commits＠lists.jboss.org
Author: epbernard
Date: 2008-12-02 07:18:30 -0500 (Tue, 02 Dec 2008)
New Revision: 15633
Modified:
validator/trunk/validation-api/src/test/java/org/hibernate/validator/spec/s2/s4/FineGrainedLengthConstraint.java
Log:
typos
Modified: validator/trunk/validation-api/src/test/java/org/hibernate/validator/spec/s2/s4/FineGrainedLengthConstraint.java
===================================================================
--- validator/trunk/validation-api/src/test/java/org/hibernate/validator/spec/s2/s4/FineGrainedLengthConstraint.java 2008-12-02 11:03:35 UTC (rev 15632)
+++ validator/trunk/validation-api/src/test/java/org/hibernate/validator/spec/s2/s4/FineGrainedLengthConstraint.java 2008-12-02 12:18:30 UTC (rev 15633)
@@ -6,8 +6,8 @@
/**
* Check that a string length is between min and max
* Error messages are using either key:
- * - error.length.min if the min limit is reached
- * - error.length.max if the max limit is reached
+ * - constraint.length.min if the min limit is reached
+ * - constraint.length.max if the max limit is reached
*/
public class FineGrainedLengthConstraint implements Constraint<Length> {
private int min;
@@ -41,12 +41,12 @@
if (length < min) {
//add min specific error
- constraintContext.addError( "{error.length.min}" );
+ constraintContext.addError( "{constraint.length.min}" );
return false;
}
if (length > max) {
//add max specific error
- constraintContext.addError( "{error.length.max}" );
+ constraintContext.addError( "{constraint.length.max}" );
return false;
}
return true;
15 years, 4 months
- 1
- 0
Hibernate SVN: r15632 - in validator/trunk: hibernate-validator/src/main/java/org/hibernate/validation/impl and 2 other directories.
by hibernate-commits＠lists.jboss.org
Author: epbernard
Date: 2008-12-02 06:03:35 -0500 (Tue, 02 Dec 2008)
New Revision: 15632
Added:
validator/trunk/hibernate-validator/src/main/java/org/hibernate/validation/impl/BeanDescriptorImpl.java
validator/trunk/validation-api/src/main/java/javax/validation/metadata/
Modified:
validator/trunk/hibernate-validator/src/main/java/org/hibernate/validation/engine/MetaDataProviderImpl.java
validator/trunk/hibernate-validator/src/main/java/org/hibernate/validation/engine/ValidatorImpl.java
validator/trunk/hibernate-validator/src/main/java/org/hibernate/validation/impl/ElementDescriptorImpl.java
validator/trunk/hibernate-validator/src/test/java/org/hibernate/validation/engine/ValidatorImplTest.java
validator/trunk/validation-api/src/main/java/javax/validation/BeanDescriptor.java
validator/trunk/validation-api/src/main/java/javax/validation/Validator.java
Log:
BVAL-77 move metadata methods to BeanValidation
Modified: validator/trunk/hibernate-validator/src/main/java/org/hibernate/validation/engine/MetaDataProviderImpl.java
===================================================================
--- validator/trunk/hibernate-validator/src/main/java/org/hibernate/validation/engine/MetaDataProviderImpl.java 2008-12-02 09:57:05 UTC (rev 15631)
+++ validator/trunk/hibernate-validator/src/main/java/org/hibernate/validation/engine/MetaDataProviderImpl.java 2008-12-02 11:03:35 UTC (rev 15632)
@@ -41,6 +41,7 @@
import org.hibernate.validation.impl.ConstraintDescriptorImpl;
import org.hibernate.validation.impl.ConstraintFactoryImpl;
import org.hibernate.validation.impl.ElementDescriptorImpl;
+import org.hibernate.validation.impl.BeanDescriptorImpl;
import org.hibernate.validation.util.LoggerFactory;
import org.hibernate.validation.util.ReflectionHelper;
@@ -65,7 +66,7 @@
/**
* The main element descriptor for <code>beanClass</code>.
*/
- private ElementDescriptorImpl beanDescriptor;
+ private BeanDescriptorImpl<T> beanDescriptor;
/**
* List of constraints.
@@ -109,7 +110,7 @@
* for this validator and create meta data.
*/
private void createMetaData() {
- beanDescriptor = new ElementDescriptorImpl( beanClass, false, "" );
+ beanDescriptor = new BeanDescriptorImpl<T>( beanClass, this );
List<Class> classes = new ArrayList<Class>();
computeClassHierarchy( beanClass, classes );
for ( Class current : classes ) {
Modified: validator/trunk/hibernate-validator/src/main/java/org/hibernate/validation/engine/ValidatorImpl.java
===================================================================
--- validator/trunk/hibernate-validator/src/main/java/org/hibernate/validation/engine/ValidatorImpl.java 2008-12-02 09:57:05 UTC (rev 15631)
+++ validator/trunk/hibernate-validator/src/main/java/org/hibernate/validation/engine/ValidatorImpl.java 2008-12-02 11:03:35 UTC (rev 15632)
@@ -334,7 +334,11 @@
return new HashSet<ConstraintViolation<T>>( failingConstraintViolations );
}
+ public BeanDescriptor getConstraintsForClass(Class<?> clazz) {
+ return factory.getMetadataProvider( clazz ).getBeanDescriptor();
+ }
+
private <T> void validateValue(Class<T> beanType, Object object, PropertyIterator propertyIter, List<ConstraintViolationImpl<T>> failingConstraintViolations, String... groups) {
ConstraintDescriptorImpl constraintDescriptor = getConstraintDescriptorForPath( beanType, propertyIter );
@@ -492,27 +496,6 @@
/**
- * @todo add child validation
- */
- public boolean hasConstraints(Class<?> clazz) {
- return factory.getMetadataProvider( clazz ).getConstraintMetaDataList().size() > 0;
- }
-
- public BeanDescriptor getConstraintsForClass(Class<?> clazz) {
- return factory.getMetadataProvider( clazz ).getBeanDescriptor();
- }
-
- public PropertyDescriptor getConstraintsForProperty(Class<?> clazz, String propertyName) {
- return factory.getMetadataProvider( clazz ).getPropertyDescriptors().get( propertyName );
- }
-
- public Set<String> getPropertiesWithConstraints(Class<?> clazz) {
- final MetaDataProviderImpl<?> dataProvider = factory.getMetadataProvider( clazz );
- return Collections.unmodifiableSet( dataProvider.getPropertyDescriptors().keySet() );
- }
-
-
- /**
* Checks whether the provided group name is a group sequence and if so expands the group name and add the expanded
* groups names to <code>expandedGroupName </code>
*
Added: validator/trunk/hibernate-validator/src/main/java/org/hibernate/validation/impl/BeanDescriptorImpl.java
===================================================================
--- validator/trunk/hibernate-validator/src/main/java/org/hibernate/validation/impl/BeanDescriptorImpl.java (rev 0)
+++ validator/trunk/hibernate-validator/src/main/java/org/hibernate/validation/impl/BeanDescriptorImpl.java 2008-12-02 11:03:35 UTC (rev 15632)
@@ -0,0 +1,35 @@
+package org.hibernate.validation.impl;
+
+import java.util.Set;
+import java.util.Collections;
+import javax.validation.BeanDescriptor;
+import javax.validation.PropertyDescriptor;
+
+import org.hibernate.validation.engine.MetaDataProvider;
+
+/**
+ * @author Emmanuel Bernard
+ */
+public class BeanDescriptorImpl<T> extends ElementDescriptorImpl implements BeanDescriptor {
+ private final MetaDataProvider<T> metadataProvider;
+
+ public BeanDescriptorImpl(Class<T> returnType, MetaDataProvider<T> metadataProvider) {
+ super(returnType, false, "");
+ this.metadataProvider = metadataProvider;
+ }
+
+ /**
+ * @todo add child validation
+ */
+ public boolean hasConstraints() {
+ return metadataProvider.getConstraintMetaDataList().size() > 0;
+ }
+
+ public PropertyDescriptor getConstraintsForProperty(String propertyName) {
+ return metadataProvider.getPropertyDescriptors().get( propertyName );
+ }
+
+ public Set<String> getPropertiesWithConstraints() {
+ return Collections.unmodifiableSet( metadataProvider.getPropertyDescriptors().keySet() );
+ }
+}
Modified: validator/trunk/hibernate-validator/src/main/java/org/hibernate/validation/impl/ElementDescriptorImpl.java
===================================================================
--- validator/trunk/hibernate-validator/src/main/java/org/hibernate/validation/impl/ElementDescriptorImpl.java 2008-12-02 09:57:05 UTC (rev 15631)
+++ validator/trunk/hibernate-validator/src/main/java/org/hibernate/validation/impl/ElementDescriptorImpl.java 2008-12-02 11:03:35 UTC (rev 15632)
@@ -35,14 +35,14 @@
* @todo Handle problem in descirbing cyclic dependecies for propertyPath
*/
//FIXME I implement both interfaces on the same object as a quick hack, we need to fix that.
-public class ElementDescriptorImpl implements PropertyDescriptor, BeanDescriptor {
- private final Class returnType;
+public class ElementDescriptorImpl implements PropertyDescriptor {
+ private final Class<?> returnType;
private final boolean cascaded;
private final List<ConstraintDescriptor> constraintDescriptors = new ArrayList<ConstraintDescriptor>();
private final String propertyPath;
- public ElementDescriptorImpl(Class returnType, boolean cascaded, String propertyPath) {
+ public ElementDescriptorImpl(Class<?> returnType, boolean cascaded, String propertyPath) {
this.returnType = returnType;
this.cascaded = cascaded;
this.propertyPath = propertyPath;
Modified: validator/trunk/hibernate-validator/src/test/java/org/hibernate/validation/engine/ValidatorImplTest.java
===================================================================
--- validator/trunk/hibernate-validator/src/test/java/org/hibernate/validation/engine/ValidatorImplTest.java 2008-12-02 09:57:05 UTC (rev 15631)
+++ validator/trunk/hibernate-validator/src/test/java/org/hibernate/validation/engine/ValidatorImplTest.java 2008-12-02 11:03:35 UTC (rev 15632)
@@ -70,7 +70,7 @@
@Test
public void testWrongMethodName() {
try {
- getHibernateValidator().hasConstraints( Boy.class );
+ getHibernateValidator().getConstraintsForClass( Boy.class ).hasConstraints();
fail();
}
catch ( ValidationException e ) {
@@ -85,19 +85,19 @@
@Test(expected = IllegalArgumentException.class)
public void testNullParamterToValidatorImplConstructor() {
- getHibernateValidator().hasConstraints( null );
+ getHibernateValidator().getConstraintsForClass( null );
}
@Test
public void testUnconstraintClass() {
Validator validator = getHibernateValidator();
- assertTrue( "There should be no constraints", !validator.hasConstraints( Unconstraint.class ) );
+ assertTrue( "There should be no constraints", !validator.getConstraintsForClass( Unconstraint.class ).hasConstraints() );
}
@Test
public void testHasConstraints() {
Validator validator = getHibernateValidator();
- assertTrue( "There should be constraints", validator.hasConstraints( Customer.class ) );
+ assertTrue( "There should be constraints", validator.getConstraintsForClass( Customer.class ).hasConstraints() );
}
@Test(expected = IllegalArgumentException.class)
@@ -271,7 +271,7 @@
@Test(expected = ValidationException.class)
public void testInvalidSequenceName() {
Validator validator = getHibernateValidator();
- validator.hasConstraints( EnglishDictonary.class );
+ validator.getConstraintsForClass( EnglishDictonary.class ).hasConstraints();
}
@Test
Modified: validator/trunk/validation-api/src/main/java/javax/validation/BeanDescriptor.java
===================================================================
--- validator/trunk/validation-api/src/main/java/javax/validation/BeanDescriptor.java 2008-12-02 09:57:05 UTC (rev 15631)
+++ validator/trunk/validation-api/src/main/java/javax/validation/BeanDescriptor.java 2008-12-02 11:03:35 UTC (rev 15632)
@@ -1,9 +1,31 @@
package javax.validation;
+import java.util.Set;
+
/**
* Describe a constrained Java Bean and the constraints associated to it.
*
* @author Emmanuel Bernard
*/
public interface BeanDescriptor extends ElementDescriptor {
+ /**
+ * return true if at least one constraint declaration is present for the given bean
+ * or if one property is marked for validation cascade
+ */
+ boolean hasConstraints();
+
+ /**
+ * Return the property level constraints for a given propertyName
+ * or null if either the property does not exist or has no constraint
+ * The returned object (and associated objects including ConstraintDescriptors)
+ * are immutable.
+ *
+ * @param propertyName property evaludated
+ */
+ PropertyDescriptor getConstraintsForProperty(String propertyName);
+
+ /**
+ * return the property names having at least a constraint defined
+ */
+ Set<String> getPropertiesWithConstraints();
}
Modified: validator/trunk/validation-api/src/main/java/javax/validation/Validator.java
===================================================================
--- validator/trunk/validation-api/src/main/java/javax/validation/Validator.java 2008-12-02 09:57:05 UTC (rev 15631)
+++ validator/trunk/validation-api/src/main/java/javax/validation/Validator.java 2008-12-02 11:03:35 UTC (rev 15632)
@@ -73,14 +73,6 @@
<T> Set<ConstraintViolation<T>> validateValue(Class<T> beanType, String propertyName, Object value, String... groups);
/**
- * return true if at least one constraint declaration is present for the given bean
- * or if one property is marked for validation cascade
- *
- * @param clazz class type evaluated
- */
- boolean hasConstraints(Class<?> clazz);
-
- /**
* Return the class level constraints
* The returned object (and associated objects including ConstraintDescriptors)
* are immutable.
@@ -88,23 +80,4 @@
* @param clazz class type evaluated
*/
BeanDescriptor getConstraintsForClass(Class<?> clazz);
-
- /**
- * Return the property level constraints for a given propertyName
- * or null if either the property does not exist or has no constraint
- * The returned object (and associated objects including ConstraintDescriptors)
- * are immutable.
- *
- * @param clazz class type evaluated
- * @param propertyName property evaludated
- */
- PropertyDescriptor getConstraintsForProperty(Class<?> clazz, String propertyName);
-
- /**
- * return the property names having at least a constraint defined
- *
- * @param clazz class type evaluated
- */
- Set<String> getPropertiesWithConstraints(Class<?> clazz);
-
}
15 years, 4 months
- 1
- 0
Hibernate SVN: r15631 - in validator/trunk/validation-api/src: main/java/javax/validation/spi and 7 other directories.
by hibernate-commits＠lists.jboss.org
Author: epbernard
Date: 2008-12-02 04:57:05 -0500 (Tue, 02 Dec 2008)
New Revision: 15631
Added:
validator/trunk/validation-api/src/test/java/org/
validator/trunk/validation-api/src/test/java/org/hibernate/
validator/trunk/validation-api/src/test/java/org/hibernate/validator/
validator/trunk/validation-api/src/test/java/org/hibernate/validator/spec/
validator/trunk/validation-api/src/test/java/org/hibernate/validator/spec/s2/
validator/trunk/validation-api/src/test/java/org/hibernate/validator/spec/s2/s4/
validator/trunk/validation-api/src/test/java/org/hibernate/validator/spec/s2/s4/FineGrainedLengthConstraint.java
validator/trunk/validation-api/src/test/java/org/hibernate/validator/spec/s2/s4/Length.java
validator/trunk/validation-api/src/test/java/org/hibernate/validator/spec/s2/s4/LengthConstraint.java
Modified:
validator/trunk/validation-api/src/main/java/javax/validation/ConstraintDescriptor.java
validator/trunk/validation-api/src/main/java/javax/validation/Validation.java
validator/trunk/validation-api/src/main/java/javax/validation/Validator.java
validator/trunk/validation-api/src/main/java/javax/validation/spi/ValidationProvider.java
Log:
Typos and add first code form spec examples
Modified: validator/trunk/validation-api/src/main/java/javax/validation/ConstraintDescriptor.java
===================================================================
--- validator/trunk/validation-api/src/main/java/javax/validation/ConstraintDescriptor.java 2008-12-02 08:17:41 UTC (rev 15630)
+++ validator/trunk/validation-api/src/main/java/javax/validation/ConstraintDescriptor.java 2008-12-02 09:57:05 UTC (rev 15631)
@@ -51,19 +51,21 @@
* Returns a map containing the annotation parameter names as keys and the
* annotation parameter values as value.
* If this constraint is used as part of a composed constraint, parameter
- * values are reflecting the overridden parameters form the main constraint.
+ * values are reflecting the overridden parameters from the main constraint.
*
- * @return Returns a map containing the annotation paramter names as keys and the annotation parameter values
- * as value.
+ * @return Returns a map containing the annotation paramter names as keys
+ * and the annotation parameter values as value.
*/
Map<String, Object> getParameters();
/**
- * Return a set of composing <code>ConstraintDescriptor</code>s where each descriptor describes a composing
- * constraint. <code>ConstraintDescriptor</code> instances of composing constraints reflect overridden
- * parameter values in {@link #getParameters()} and {@link #getAnnotation()}.
+ * Return a set of composing <code>ConstraintDescriptor</code>s where each
+ * descriptor describes a composing constraint. <code>ConstraintDescriptor</code>
+ * instances of composing constraints reflect overridden parameter values in
+ * {@link #getParameters()} and {@link #getAnnotation()}.
*
- * @return a set of <code>ConstraintDescriptor<code> objects or an empty set in case there are no composing constraints.
+ * @return a set of <code>ConstraintDescriptor<code> objects or an empty set
+ * in case there are no composing constraints.
*/
Set<ConstraintDescriptor> getComposingConstraints();
Modified: validator/trunk/validation-api/src/main/java/javax/validation/Validation.java
===================================================================
--- validator/trunk/validation-api/src/main/java/javax/validation/Validation.java 2008-12-02 08:17:41 UTC (rev 15630)
+++ validator/trunk/validation-api/src/main/java/javax/validation/Validation.java 2008-12-02 09:57:05 UTC (rev 15631)
@@ -38,7 +38,7 @@
* The chosen provider is defined as followed:
* <ul>
* <li>if the XML configuration defines a provider, this provider is used</li>
- * <li>if the XML configuratio does not define a provider or if no XML configuration
+ * <li>if the XML configuration does not define a provider or if no XML configuration
* is present the first provider returned by the ValidationProviderResolver
* isntance is used.</li>
* </ul>
Modified: validator/trunk/validation-api/src/main/java/javax/validation/Validator.java
===================================================================
--- validator/trunk/validation-api/src/main/java/javax/validation/Validator.java 2008-12-02 08:17:41 UTC (rev 15630)
+++ validator/trunk/validation-api/src/main/java/javax/validation/Validator.java 2008-12-02 09:57:05 UTC (rev 15631)
@@ -52,7 +52,7 @@
*
* @return constraint violations or an empty Set if none
*
- * @throws IllegalArgumentException e if object is null
+ * @throws IllegalArgumentException e if object is null or if propertyName is not present
*/
<T> Set<ConstraintViolation<T>> validateProperty(T object, String propertyName, String... groups);
@@ -68,6 +68,7 @@
* for validation (default to <code>default</code>)
*
* @return constraint violations or an empty Set if none
+ * @throws IllegalArgumentException e if propertyName is not present
*/
<T> Set<ConstraintViolation<T>> validateValue(Class<T> beanType, String propertyName, Object value, String... groups);
Modified: validator/trunk/validation-api/src/main/java/javax/validation/spi/ValidationProvider.java
===================================================================
--- validator/trunk/validation-api/src/main/java/javax/validation/spi/ValidationProvider.java 2008-12-02 08:17:41 UTC (rev 15630)
+++ validator/trunk/validation-api/src/main/java/javax/validation/spi/ValidationProvider.java 2008-12-02 09:57:05 UTC (rev 15631)
@@ -47,7 +47,7 @@
* to build the ValidatorFactory instance.
* <p/>
* This method can only be called on providers returning true on <
- * code>#issuitable(builderType)</code>
+ * code>#isSuitable(builderType)</code>
*
* @param builderClass the Builder class type
* @param state bootstrap state
Added: validator/trunk/validation-api/src/test/java/org/hibernate/validator/spec/s2/s4/FineGrainedLengthConstraint.java
===================================================================
--- validator/trunk/validation-api/src/test/java/org/hibernate/validator/spec/s2/s4/FineGrainedLengthConstraint.java (rev 0)
+++ validator/trunk/validation-api/src/test/java/org/hibernate/validator/spec/s2/s4/FineGrainedLengthConstraint.java 2008-12-02 09:57:05 UTC (rev 15631)
@@ -0,0 +1,54 @@
+package org.hibernate.validator.spec.s2.s4;
+
+import javax.validation.ConstraintContext;
+import javax.validation.Constraint;
+
+/**
+ * Check that a string length is between min and max
+ * Error messages are using either key:
+ * - error.length.min if the min limit is reached
+ * - error.length.max if the max limit is reached
+ */
+public class FineGrainedLengthConstraint implements Constraint<Length> {
+ private int min;
+ private int max;
+
+ /**
+ * Configure the constraint validator based on the elements
+ * specified at the time it was defined.
+ * @param constraint the constraint definition
+ */
+ public void initialize(Length constraint) {
+ min = constraint.min();
+ max = constraint.max();
+ }
+
+ /**
+ * Validate a specified value.
+ * returns false if the specified value does not conform to the definition
+ * @exception IllegalArgumentException if the object is not of type String
+ */
+ public boolean isValid(Object value, ConstraintContext constraintContext) {
+ if ( value == null ) return true;
+ if ( !( value instanceof String ) ) {
+ throw new IllegalArgumentException("Expected String type");
+ }
+ String string = (String) value;
+ int length = string.length();
+
+ //remove default error
+ constraintContext.disableDefaultError();
+
+ if (length < min) {
+ //add min specific error
+ constraintContext.addError( "{error.length.min}" );
+ return false;
+ }
+ if (length > max) {
+ //add max specific error
+ constraintContext.addError( "{error.length.max}" );
+ return false;
+ }
+ return true;
+ }
+}
\ No newline at end of file
Added: validator/trunk/validation-api/src/test/java/org/hibernate/validator/spec/s2/s4/Length.java
===================================================================
--- validator/trunk/validation-api/src/test/java/org/hibernate/validator/spec/s2/s4/Length.java (rev 0)
+++ validator/trunk/validation-api/src/test/java/org/hibernate/validator/spec/s2/s4/Length.java 2008-12-02 09:57:05 UTC (rev 15631)
@@ -0,0 +1,22 @@
+package org.hibernate.validator.spec.s2.s4;
+
+import java.lang.annotation.Target;
+import java.lang.annotation.Retention;
+import java.lang.annotation.Documented;
+import static java.lang.annotation.RetentionPolicy.RUNTIME;
+import static java.lang.annotation.ElementType.METHOD;
+import static java.lang.annotation.ElementType.FIELD;
+import static java.lang.annotation.ElementType.ANNOTATION_TYPE;
+import javax.validation.ConstraintValidator;
+
+/**
+ * @author Emmanuel Bernard
+ */
+@Target({ METHOD, FIELD, ANNOTATION_TYPE })
+@Retention(RUNTIME)
+@Documented
+(a)ConstraintValidator(LengthConstraint.class)
+public @interface Length {
+ int min() default Integer.MIN_VALUE;
+ int max() default Integer.MAX_VALUE;
+}
Added: validator/trunk/validation-api/src/test/java/org/hibernate/validator/spec/s2/s4/LengthConstraint.java
===================================================================
--- validator/trunk/validation-api/src/test/java/org/hibernate/validator/spec/s2/s4/LengthConstraint.java (rev 0)
+++ validator/trunk/validation-api/src/test/java/org/hibernate/validator/spec/s2/s4/LengthConstraint.java 2008-12-02 09:57:05 UTC (rev 15631)
@@ -0,0 +1,38 @@
+package org.hibernate.validator.spec.s2.s4;
+
+import javax.validation.ConstraintContext;
+import javax.validation.Constraint;
+
+/**
+ * Check that a string length is between min and max
+ *
+ */
+public class LengthConstraint implements Constraint<Length> {
+ private int min;
+ private int max;
+
+ /**
+ * Configure the constraint validator based on the elements
+ * specified at the time it was defined.
+ * @param constraint the constraint definition
+ */
+ public void initialize(Length constraint) {
+ min = constraint.min();
+ max = constraint.max();
+ }
+
+ /**
+ * Validate a specified value.
+ * returns false if the specified value does not conform to the definition
+ * @exception IllegalArgumentException if the object is not of type String
+ */
+ public boolean isValid(Object value, ConstraintContext constraintContext) {
+ if ( value == null ) return true;
+ if ( !( value instanceof String ) ) {
+ throw new IllegalArgumentException("Expected String type");
+ }
+ String string = (String) value;
+ int length = string.length();
+ return length >= min && length <= max;
+ }
+}
15 years, 4 months
- 1
- 0
Hibernate SVN: r15630 - validator/trunk/validation-api/src/main/java/javax/validation.
by hibernate-commits＠lists.jboss.org
Author: epbernard
Date: 2008-12-02 03:17:41 -0500 (Tue, 02 Dec 2008)
New Revision: 15630
Modified:
validator/trunk/validation-api/src/main/java/javax/validation/Constraint.java
validator/trunk/validation-api/src/main/java/javax/validation/ConstraintValidator.java
validator/trunk/validation-api/src/main/java/javax/validation/OverridesParameter.java
Log:
Fix typos
Modified: validator/trunk/validation-api/src/main/java/javax/validation/Constraint.java
===================================================================
--- validator/trunk/validation-api/src/main/java/javax/validation/Constraint.java 2008-12-01 12:40:33 UTC (rev 15629)
+++ validator/trunk/validation-api/src/main/java/javax/validation/Constraint.java 2008-12-02 08:17:41 UTC (rev 15630)
@@ -37,12 +37,13 @@
void initialize(A constraintAnnotation);
/**
- * Implement the validation constraint
+ * Implement the validation constraint.
+ * <code>object</code> state must not be changed by a Constraint implementation
*
* @param object object to validate
* @param constraintContext context in which the constraint implementation is evaluated
*
- * @return true if object pass the constraint
+ * @return false if <code>object</code> does not pass the constraint
*/
boolean isValid(Object object, ConstraintContext constraintContext);
}
Modified: validator/trunk/validation-api/src/main/java/javax/validation/ConstraintValidator.java
===================================================================
--- validator/trunk/validation-api/src/main/java/javax/validation/ConstraintValidator.java 2008-12-01 12:40:33 UTC (rev 15629)
+++ validator/trunk/validation-api/src/main/java/javax/validation/ConstraintValidator.java 2008-12-02 08:17:41 UTC (rev 15630)
@@ -25,7 +25,7 @@
/**
- * Link between an constraint annotation and it's constraint validation implementation.
+ * Link between a constraint annotation and it's constraint validation implementation.
* <p/>
* An given constraint annotation should be annotated by a @ConstraintValidator
* annotation which refers to its constraint validation implementation.
Modified: validator/trunk/validation-api/src/main/java/javax/validation/OverridesParameter.java
===================================================================
--- validator/trunk/validation-api/src/main/java/javax/validation/OverridesParameter.java 2008-12-01 12:40:33 UTC (rev 15629)
+++ validator/trunk/validation-api/src/main/java/javax/validation/OverridesParameter.java 2008-12-02 08:17:41 UTC (rev 15630)
@@ -46,7 +46,7 @@
/**
* index of the targetted constraint declaration when using
* multiple constraints of the same type.
- * The index represent the index of the constraint in the value() array.
+ * The index represents the index of the constraint in the value() array.
*
* By default, no index is defined and the single constraint declaration
* is targeted
15 years, 4 months
- 1
- 0
Hibernate SVN: r15629 - search/trunk/doc/reference/en/modules.
by hibernate-commits＠lists.jboss.org
Author: hardy.ferentschik
Date: 2008-12-01 07:40:33 -0500 (Mon, 01 Dec 2008)
New Revision: 15629
Modified:
search/trunk/doc/reference/en/modules/mapping.xml
Log:
reviewed mapping chapter
Modified: search/trunk/doc/reference/en/modules/mapping.xml
===================================================================
--- search/trunk/doc/reference/en/modules/mapping.xml 2008-11-29 14:06:12 UTC (rev 15628)
+++ search/trunk/doc/reference/en/modules/mapping.xml 2008-12-01 12:40:33 UTC (rev 15629)
@@ -30,15 +30,17 @@
<title>Mapping entities to the index structure</title>
<para>All the metadata information needed to index entities is described
- through some Java annotations. There is no need for xml mapping files (in
- fact there exists currently no xml configuration option) nor a list of
- indexed entities. The list is discovered at startup time scanning the
- Hibernate mapped entities.</para>
+ through annotations. There is no need for xml mapping files. In fact there
+ is currently no xml configuration option available (see <ulink
+ url="http://opensource.atlassian.com/projects/hibernate/browse/HSEARCH-210">HSEARCH-210</ulink>).
+ You can still use hibernate mapping files for the basic Hibernate
+ configuration, but the Search specific configuration has to be expressed via
+ annotations.</para>
<section id="search-mapping-entity" revision="3">
<title>Mapping an entity</title>
- <section>
+ <section id="basic-mapping">
<title>Basic mapping</title>
<para>First, we must declare a persistent class as indexable. This is
@@ -53,16 +55,20 @@
}</programlisting>
<para>The <literal>index</literal> attribute tells Hibernate what the
- Lucene directory name is (usually a directory on your file system). If
- you wish to define a base directory for all Lucene indexes, you can use
+ Lucene directory name is (usually a directory on your file system). It
+ is recommended to define a base directory for all Lucene indexes using
the <literal>hibernate.search.default.indexBase</literal> property in
- your configuration file. Each entity instance will be represented by a
- Lucene <classname>Document</classname> inside the given index (aka
+ your configuration file. Alternatively you can specify a base directory
+ per indexed entity by specifying
+ <literal>hibernate.search.<index>.indexBase, </literal>where
+ <literal><index></literal> is the fully qualified classname of the
+ indexed entity. Each entity instance will be represented by a Lucene
+ <classname>Document</classname> inside the given index (aka
Directory).</para>
<para>For each property (or attribute) of your entity, you have the
- ability to describe how it will be indexed. The default (ie no
- annotation) means that the property is completly ignored by the indexing
+ ability to describe how it will be indexed. The default (no annotation
+ present) means that the property is completly ignored by the indexing
process. <literal>@Field</literal> does declare a property as indexed.
When indexing an element to a Lucene document you can specify how it is
indexed:</para>
@@ -82,20 +88,20 @@
information), store it in a compressed way
<literal>Store.COMPRESS</literal> (this does consume more CPU), or
avoid any storage <literal>Store.NO</literal> (this is the default
- value). When a property is stored, you can retrieve it from the
- Lucene Document (note that this is not related to whether the
- element is indexed or not).</para>
+ value). When a property is stored, you can retrieve its original
+ value from the Lucene Document. This is not related to whether the
+ element is indexed or not.</para>
</listitem>
<listitem>
- <para>index: describe how the element is indexed (ie the process
- used to index the property and the type of information store). The
- different values are <literal>Index.NO</literal> (no indexing, ie
- cannot be found by a query), <literal>Index.TOKENIZED</literal> (use
- an analyzer to process the property),
- <literal>Index.UN_TOKENISED</literal> (no analyzer pre processing),
- <literal>Index.NO_NORM</literal> (do not store the normalization
- data). The default value is <literal>TOKENIZED</literal>.</para>
+ <para>index: describe how the element is indexed and the type of
+ information store. The different values are
+ <literal>Index.NO</literal> (no indexing, ie cannot be found by a
+ query), <literal>Index.TOKENIZED</literal> (use an analyzer to
+ process the property), <literal>Index.UN_TOKENISED</literal> (no
+ analyzer pre processing), <literal>Index.NO_NORM</literal> (do not
+ store the normalization data). The default value is
+ <literal>TOKENIZED</literal>.</para>
</listitem>
<listitem>
@@ -104,12 +110,10 @@
they are available within documents. The default value is
TermVector.NO.</para>
- <para>The different values of this attribute are</para>
+ <para>The different values of this attribute are:</para>
<informaltable align="left" width="">
<tgroup cols="2">
- <colspec align="center" />
-
<thead>
<row>
<entry align="center">Value</entry>
@@ -165,19 +169,16 @@
</listitem>
</itemizedlist>
- <para>These attributes are part of the <literal>@Field</literal>
- annotation.</para>
+ <para>Whether or not you want to store the original data in the index
+ depends on how you wish to use the index query result. For a regular
+ Hibernate Search usage storing is not necessary. However you might want
+ to store some fields to subsequently project them (see <xref
+ linkend="projections" /> for more information).</para>
- <para>Whether or not you want to store the data depends on how you wish
- to use the index query result. For a regular Hibernate Search usage,
- storing is not necessary. However you might want to store some fields to
- subsequently project them (see <xref linkend="projections" /> for more
- information).</para>
-
<para>Whether or not you want to tokenize a property depends on whether
you wish to search the element as is, or by the words it contains. It
- make sense to tokenize a text field, but it does not to do it for a date
- field (or an id field). Note that fields used for sorting must not be
+ make sense to tokenize a text field, but tokenizing a date field
+ probably not. Note that fields used for sorting must not be
tokenized.</para>
<para>Finally, the id property of an entity is a special property used
@@ -205,7 +206,7 @@
public String getText() { return text; }
}</programlisting>
- <para>These annotations define an index with three fields:
+ <para>The above annotations define an index with three fields:
<literal>id</literal> , <literal>Abstract</literal> and
<literal>text</literal> . Note that by default the field name is
decapitalized, following the JavaBean specification</para>
@@ -214,20 +215,20 @@
<section>
<title>Mapping properties multiple times</title>
- <para>It is sometimes needed to map a property multiple times per index,
- with slightly different indexing strategies. Especially, sorting a query
- by field requires the field to be <literal>UN_TOKENIZED</literal>. If
- one want to search by words in this property and still sort it, one need
- to index it twice, once tokenized, once untokenized. @Fields allows to
+ <para>Sometimes one has to map a property multiple times per index, with
+ slightly different indexing strategies. For example, sorting a query by
+ field requires the field to be <literal>UN_TOKENIZED</literal>. If one
+ wants to search by words in this property and still sort it, one need to
+ index it twice - once tokenized and once untokenized. @Fields allows to
achieve this goal.</para>
<programlisting>@Entity
@Indexed(index = "Book" )
public class Book {
- @Fields( {
+ <emphasis role="bold">@Fields( {</emphasis>
@Field(index = Index.TOKENIZED),
@Field(name = "summary_forSort", index = Index.UN_TOKENIZED, store = Store.YES)
- } )
+ <emphasis role="bold">} )</emphasis>
public String getSummary() {
return summary;
}
@@ -235,7 +236,7 @@
...
}</programlisting>
- <para>The field summary is indexed twice, once as
+ <para>The field <literal>summary</literal> is indexed twice, once as
<literal>summary</literal> in a tokenized way, and once as
<literal>summary_forSort</literal> in an untokenized way. @Field
supports 2 attributes useful when @Fields is used:</para>
@@ -260,10 +261,10 @@
<title>Embedded and associated objects</title>
<para>Associated objects as well as embedded objects can be indexed as
- part of the root entity index. It is necessary if you expect to search a
- given entity based on properties of the associated object(s). In the
- following example, the use case is to return the places whose city is
- Atlanta (In the Lucene query parser language, it would translate into
+ part of the root entity index. This is ueful if you expect to search a
+ given entity based on properties of associated objects. In the following
+ example the aim is to return places where the associated city is Atlanta
+ (In the Lucene query parser language, it would translate into
<code>address.city:Atlanta</code>).</para>
<programlisting>@Entity
@@ -284,11 +285,9 @@
}
@Entity
-@Indexed
public class Address {
@Id
@GeneratedValue
- @DocumentId
private Long id;
@Field(index=Index.TOKENIZED)
@@ -312,10 +311,12 @@
<para>Be careful. Because the data is denormalized in the Lucene index
when using the <classname>@IndexedEmbedded</classname> technique,
- Hibernate Search needs to be aware of any change in the Place object and
- any change in the Address object to keep the index up to date. To make
- sure the Place Lucene document is updated when it's Address changes, you
- need to mark the other side of the birirectional relationship with
+ Hibernate Search needs to be aware of any change in the
+ <classname>Place</classname> object and any change in the
+ <classname>Address</classname> object to keep the index up to date. To
+ make sure the <literal><classname>Place</classname></literal> Lucene
+ document is updated when it's <classname>Address</classname> changes,
+ you need to mark the other side of the birirectional relationship with
<classname>@ContainedIn</classname>.</para>
<para><literal>@ContainedIn</literal> is only useful on associations
@@ -342,11 +343,9 @@
}
@Entity
-@Indexed
public class Address {
@Id
@GeneratedValue
- @DocumentId
private Long id;
@Field(index=Index.TOKENIZED)
@@ -404,20 +403,24 @@
the <literal>prefix</literal> attribute as it is shown on the
<literal>ownedBy</literal> property.</para>
- <para><literal>depth</literal> is necessary when the object graph
- contains a cyclic dependency of classes (not instances). For example, if
- <classname>Owner</classname> points to <classname>Place</classname>.
- Hibernate Search will stop including Indexed embedded atttributes after
- reaching the expected depth (or the object graph boundaries are
- reached). A class having a self reference is an example of cyclic
- dependency. In our example, because <literal>depth</literal> is set to
- 1, any <literal>@IndexedEmbedded</literal> attribute in Owner (if any)
- will be ignored.</para>
+ <note>
+ <para>The prefix cannot be set to the empty string. </para>
+ </note>
- <para>Such a feature (<literal>@IndexedEmbedded</literal>) is very
- useful to express queries refering to associated objects, such
- as:</para>
+ <para>The<literal> depth</literal> property is necessary when the object
+ graph contains a cyclic dependency of classes (not instances). For
+ example, if <classname>Owner</classname> points to
+ <classname>Place</classname>. Hibernate Search will stop including
+ Indexed embedded atttributes after reaching the expected depth (or the
+ object graph boundaries are reached). A class having a self reference is
+ an example of cyclic dependency. In our example, because
+ <literal>depth</literal> is set to 1, any
+ <literal>@IndexedEmbedded</literal> attribute in Owner (if any) will be
+ ignored. </para>
+ <para>Using <literal>@IndexedEmbedded</literal> for object associations
+ allows you to express queries such as:</para>
+
<itemizedlist>
<listitem>
<para>Return places where name contains JBoss and where address city
@@ -438,7 +441,7 @@
efficient way (at the cost of data duplication). Remember that, out of
the box, Lucene indexes have no notion of association, the join
operation is simply non-existent. It might help to keep the relational
- model normalzed while benefiting from the full text index speed and
+ model normalized while benefiting from the full text index speed and
feature richness.</para>
<para><note>
@@ -456,10 +459,10 @@
<para>Sometimes, the object type annotated by
<classname>@IndexedEmbedded</classname> is not the object type targeted
- by Hibernate and Hibernate Search especially when interfaces are used in
- lieu of their implementation. You can override the object type targeted
- by Hibernate Search using the <methodname>targetElement</methodname>
- parameter.</para>
+ by Hibernate and Hibernate Search. This is especially the case when
+ interfaces are used in lieu of their implementation. For this reason you
+ can override the object type targeted by Hibernate Search using the
+ <methodname>targetElement</methodname> parameter.</para>
<programlisting>@Entity
@Indexed
@@ -516,9 +519,11 @@
} </programlisting>
- <para>In our example, Essay's probability to reach the top of the search
- list will be multiplied by 1.7. The <methodname>summary</methodname>
- field will be 2.5 (2 * 1.5) more important than the
+ <para>In our example, <classname>Essay</classname>'s probability to
+ reach the top of the search list will be multiplied by 1.7. The
+ <methodname>summary</methodname> field will be 3.0 (2 * 1.5 -
+ <methodname>@Field.boost</methodname> and <classname>@Boost</classname>
+ on a property are cumulative) more important than the
<methodname>isbn</methodname> field. The <methodname>text</methodname>
field will be 1.2 times more important than the
<methodname>isbn</methodname> field. Note that this explanation in
@@ -526,10 +531,6 @@
reality for all practical purposes. Please check the Lucene
documentation or the excellent <citetitle>Lucene In Action </citetitle>
from Otis Gospodnetic and Erik Hatcher.</para>
-
- <para><methodname>@Field.boost</methodname>,
- <classname>@Boost</classname> on a property and
- <classname>@Boost</classname> on a class are all cumulative.</para>
</section>
<section id="analyzer">
@@ -546,7 +547,7 @@
<programlisting>@Entity
@Indexed
-@Analyzer(impl = EntityAnalyzer.class)
+<emphasis role="bold">@Analyzer(impl = EntityAnalyzer.class)</emphasis>
public class MyEntity {
@Id
@GeneratedValue
@@ -557,10 +558,10 @@
private String name;
@Field(index = Index.TOKENIZED)
- @Analyzer(impl = PropertyAnalyzer.class)
+ <emphasis role="bold">@Analyzer(impl = PropertyAnalyzer.class)</emphasis>
private String summary;
- @Field(index = Index.TOKENIZED, analyzer = @Analyzer(impl = FieldAnalyzer.class)
+ @Field(index = Index.TOKENIZED, <emphasis><emphasis role="bold">analyzer = @Analyzer(impl = FieldAnalyzer.class</emphasis>)</emphasis>
private String body;
...
@@ -609,8 +610,8 @@
</itemizedlist>
<para>This separation of tasks - a tokenizer followed by a list of
- filters - allows easy reuse of each individual component and let you
- build your customized analyzer in a very flexible way (just like
+ filters - allows for easy reuse of each individual component and let
+ you build your customized analyzer in a very flexible way (just like
lego). Generally speaking the <classname>Tokenizer</classname> starts
the analysis process by turning the character input into tokens which
are then further processed by the <classname>TokenFilter</classname>s.
@@ -644,7 +645,7 @@
building the tokenizer and using the optional list of parameters. This
example use the standard tokenizer. A filter is defined by its factory
which is responsible for creating the filter instance using the
- opetional paramenters. In our example, the StopFilter filter is built
+ optional parameters. In our example, the StopFilter filter is built
reading the dedicated words property file and is expected to ignore
case. The list of parameters is dependent on the tokenizer or filter
factory.</para>
@@ -688,7 +689,7 @@
should be analyzed with the same analyzer used to index the field so
that they speak a common "language": the same tokens are reused
between the query and the indexing process. This rule has some
- exceptions but is true most of the time, respect it unless you know
+ exceptions but is true most of the time. Respect it unless you know
what you are doing.</para>
</section>
@@ -803,7 +804,7 @@
</tgroup>
</table>
- <para>Don't hesitate to check all the implementations of
+ <para>We recommend to check all the implementations of
<classname>org.apache.solr.analysis.TokenizerFactory</classname> and
<classname>org.apache.solr.analysis.TokenFilterFactory</classname> in
your IDE to see the implementations available.</para>
@@ -841,9 +842,11 @@
fullTextSession.getSearchFactory().getAnalyzer( Song.class )
);
-org.apache.lucene.search.Query luceneQuery = parser.parse( "title:sky Or title_stemmed:diamond" );
+org.apache.lucene.search.Query luceneQuery =
+ parser.parse( "title:sky Or title_stemmed:diamond" );
-org.hibernate.Query fullTextQuery = fullTextSession.createFullTextQuery( luceneQuery, Song.class );
+org.hibernate.Query fullTextQuery =
+ fullTextSession.createFullTextQuery( luceneQuery, Song.class );
List result = fullTextQuery.list(); //return a list of managed objects </programlisting>
</example>
@@ -855,13 +858,6 @@
the search factory, the query uses the appropriate analyzer depending
on the field targeted.</para>
- <note>
- <para>This is true if you use the query parser which takes the
- analyzer into consideration. If you do not use the Lucene query
- parser, make sure to use the scoped analyzer and tokenize the query
- accordingly. TODO: show an example</para>
- </note>
-
<para>If your query targets more that one query and you wish to use
your standard analyzer, make sure to describe it using an analyzer
definition. You can retrieve analyzers by their definition name using
@@ -883,9 +879,8 @@
<section>
<title>Built-in bridges</title>
- <para><literal>Hibernate Search</literal> comes bundled with a set of
- built-in bridges between a Java property type and its full text
- representation.</para>
+ <para>Hibernate Search comes bundled with a set of built-in bridges
+ between a Java property type and its full text representation.</para>
<variablelist>
<varlistentry>
@@ -912,13 +907,13 @@
<listitem>
<para>Numbers are converted in their String representation. Note
that numbers cannot be compared by Lucene (ie used in ranged
- queries) out of the box: they have to be padded <footnote>
+ queries) out of the box: they have to be padded <note>
<para>Using a Range query is debatable and has drawbacks, an
alternative approach is to use a Filter query which will
filter the result query to the appropriate range.</para>
<para>Hibernate Search will support a padding mechanism</para>
- </footnote></para>
+ </note></para>
</listitem>
</varlistentry>
@@ -968,7 +963,7 @@
<term>java.lang.Class</term>
<listitem>
- <para>Class are converted to their filly qualified class name. The
+ <para>Class are converted to their fully qualified class name. The
thread context classloader is used when the class is
rehydrated</para>
</listitem>
@@ -988,12 +983,11 @@
<title>StringBridge</title>
<para>The simplest custom solution is to give Hibernate Search an
- implementation of your expected <emphasis>object to String</emphasis>
- bridge. To do so you need to implements the
- <literal>org.hibernate.search.bridge.StringBridge</literal>
- interface.</para>
-
- <para>All implementations have to be thread-safe as they are used
+ implementation of your expected
+ <emphasis><classname>Object</classname> </emphasis>to
+ <classname>String</classname> bridge. To do so you need to implements
+ the <literal>org.hibernate.search.bridge.StringBridge</literal>
+ interface. All implementations have to be thread-safe as they are used
concurrently.</para>
<programlisting>/**
@@ -1063,21 +1057,19 @@
<para>The <classname>ParameterizedBridge</classname> interface can be
implemented by <classname>StringBridge</classname> ,
<classname>TwoWayStringBridge</classname> ,
- <classname>FieldBridge</classname> implementations (see
- bellow).</para>
+ <classname>FieldBridge</classname> implementations.</para>
<para>All implementations have to be thread-safe, but the parameters
are set during initialization and no special care is required at this
stage.</para>
- <para>If you expect to use your bridge implementation on for an id
+ <para>If you expect to use your bridge implementation on an id
property (ie annotated with <literal>@DocumentId</literal> ), you need
to use a slightly extended version of <literal>StringBridge</literal>
- named <classname>TwoWayStringBridge</classname> . <literal>Hibernate
- Search </literal> needs to read the string representation of the
- identifier and generate the object out of it. There is not difference
- in the way the <literal>@FieldBridge</literal> annotation is
- used.</para>
+ named <classname>TwoWayStringBridge</classname>. Hibernate Search
+ needs to read the string representation of the identifier and generate
+ the object out of it. There is not difference in the way the
+ <literal>@FieldBridge</literal> annotation is used.</para>
<programlisting>public class PaddedIntegerBridge implements TwoWayStringBridge, ParameterizedBridge {
@@ -1121,17 +1113,16 @@
<section>
<title>FieldBridge</title>
- <para>Some usecase requires more than a simple object to string
- translation when mapping a property to a Lucene index. To give you
- most of the flexibility you can also implement a bridge as a
- <classname>FieldBridge</classname> . This interface give you a
+ <para>Some usecases require more than a simple object to string
+ translation when mapping a property to a Lucene index. To give you the
+ greatest possible flexibility you can also implement a bridge as a
+ <classname>FieldBridge</classname>. This interface gives you a
property value and let you map it the way you want in your Lucene
- <classname>Document</classname> .This interface is very similar in its
- concept to the <productname>Hibernate</productname>
- <classname>UserType</classname> .</para>
+ <classname>Document</classname>.The interface is very similar in its
+ concept to the Hibernate<classname> UserType</classname>'s.</para>
<para>You can for example store a given property in two different
- document fields</para>
+ document fields:</para>
<programlisting>/**
* Store the date in 3 different fields - year, month, day - to ease Range Query per
@@ -1142,7 +1133,8 @@
public class DateSplitBridge implements FieldBridge {
private final static TimeZone GMT = TimeZone.getTimeZone("GMT");
- <emphasis role="bold">public void set(String name, Object value, Document document, LuceneOptions luceneOptions)</emphasis> {
+ <emphasis role="bold">public void set(String name, Object value, Document document,
+ LuceneOptions luceneOptions)</emphasis> {
Date date = (Date) value;
Calendar cal = GregorianCalendar.getInstance(GMT);
cal.setTime(date);
@@ -1189,8 +1181,8 @@
custom field bridge implementation receives the entity instance as the
value parameter instead of a particular property. Though not shown in
this example, <classname>@ClassBridge</classname> supports the
- <methodname>termVector</methodname> attribute discussed
- previously.</para>
+ <methodname>termVector</methodname> attribute discussed in section
+ <xref linkend="basic-mapping" />.</para>
<programlisting>@Entity
@Indexed
15 years, 4 months
- 1
- 0