org.exolab.castor.xml.schema.annotations.solrj
Class Field

java.lang.Object
  extended by org.exolab.castor.xml.schema.annotations.solrj.Field
All Implemented Interfaces:
java.io.Serializable

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

Element 'field' is used to specify the use of the SOLRJ

Version:
$Revision$ $Date$
See Also:
Serialized Form

Constructor Summary
Field()
           
 
Method Summary
 java.lang.String getName()
          Returns the value of field 'name'.
 boolean isValid()
          Method isValid.
 void marshal(org.xml.sax.ContentHandler handler)
           
 void marshal(java.io.Writer out)
           
 void setName(java.lang.String name)
          Sets the value of field 'name'.
static Field unmarshal(java.io.Reader reader)
          Method unmarshal.
 void validate()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Field

public Field()
Method Detail

getName

public java.lang.String getName()
Returns the value of field 'name'. The field 'name' has the following description: Attribute 'name' is used to specify the name of the index field to be mapped against.

Returns:
the value of field 'Name'.

isValid

public boolean isValid()
Method isValid.

Returns:
true if this object is valid according to the schema

marshal

public void marshal(java.io.Writer out)
             throws MarshalException,
                    ValidationException
Parameters:
out -
Throws:
MarshalException - if object is null or if any SAXException is thrown during marshaling
ValidationException - if this object is an invalid instance according to the schema

marshal

public void marshal(org.xml.sax.ContentHandler handler)
             throws java.io.IOException,
                    MarshalException,
                    ValidationException
Parameters:
handler -
Throws:
java.io.IOException - if an IOException occurs during marshaling
ValidationException - if this object is an invalid instance according to the schema
MarshalException - if object is null or if any SAXException is thrown during marshaling

setName

public void setName(java.lang.String name)
Sets the value of field 'name'. The field 'name' has the following description: Attribute 'name' is used to specify the name of the index field to be mapped against.

Parameters:
name - the value of field 'name'.

unmarshal

public static Field unmarshal(java.io.Reader reader)
                       throws MarshalException,
                              ValidationException
Method unmarshal.

Parameters:
reader -
Returns:
the unmarshaled org.exolab.castor.xml.schema.annotations.solrj.Field
Throws:
MarshalException - if object is null or if any SAXException is thrown during marshaling
ValidationException - if this object is an invalid instance according to the schema

validate

public void validate()
              throws ValidationException
Throws:
ValidationException - if this object is an invalid instance according to the schema


Intalio Inc. (C) 1999-2008. All rights reserved http://www.intalio.com