SearchDescriptor (Castor JavaDoc)

java.lang.Object
- org.xml.sax.HandlerBase
- - org.exolab.castor.dsml.SearchDescriptor

All Implemented Interfaces:

java.io.Serializable, org.xml.sax.DocumentHandler, org.xml.sax.DTDHandler, org.xml.sax.EntityResolver, org.xml.sax.ErrorHandler
```
public class SearchDescriptor
extends org.xml.sax.HandlerBase
implements java.io.Serializable
```
Version:

$Revision: 8145 $ $Date: 2006-04-25 15:08:23 -0600 (Tue, 25 Apr 2006) $

Author:

Assaf Arkin

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

(package private) static class SearchDescriptor.Names

static class SearchDescriptor.Scope

Nested Classes
Modifier and Type	Class	Description
`(package private) static class`	`SearchDescriptor.Names`
`static class`	`SearchDescriptor.Scope`

Constructor Summary

Constructors
Constructor Description

SearchDescriptor()

Constructors
Constructor	Description
`SearchDescriptor()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`addReturnAttr(java.lang.String attrName)`
`void`	`characters(char[] ch, int offset, int length)`
`void`	`endElement(java.lang.String tagName)`
`java.lang.String`	`getBaseDN()`
`java.lang.String`	`getFilter()`
`java.lang.String[]`	`getReturnAttrs()`
`int`	`getScope()`
`java.util.Enumeration`	`listReturnAttrs()`
`void`	`produce(org.xml.sax.DocumentHandler docHandler)`
`void`	`setBaseDN(java.lang.String baseDN)`
`void`	`setFilter(java.lang.String filter)`
`void`	`setScope(int scope)`
`void`	`startElement(java.lang.String tagName, org.xml.sax.AttributeList attr)`

Methods inherited from class org.xml.sax.HandlerBase
endDocument, error, fatalError, ignorableWhitespace, notationDecl, processingInstruction, resolveEntity, setDocumentLocator, startDocument, unparsedEntityDecl, warning

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- SearchDescriptor
```
public SearchDescriptor()
```

Method Detail

getScope
```
public int getScope()
```

setScope
```
public void setScope(int scope)
```

getBaseDN
```
public java.lang.String getBaseDN()
```

setBaseDN

public void setBaseDN(java.lang.String baseDN)

getFilter
```
public java.lang.String getFilter()
```

setFilter

public void setFilter(java.lang.String filter)

getReturnAttrs

public java.lang.String[] getReturnAttrs()

listReturnAttrs

public java.util.Enumeration listReturnAttrs()

addReturnAttr

public void addReturnAttr(java.lang.String attrName)

produce

public void produce(org.xml.sax.DocumentHandler docHandler)
             throws org.xml.sax.SAXException

Throws:: org.xml.sax.SAXException

startElement

public void startElement(java.lang.String tagName,
                         org.xml.sax.AttributeList attr)
                  throws org.xml.sax.SAXException

Specified by:: startElement in interface org.xml.sax.DocumentHandler
Overrides:: startElement in class org.xml.sax.HandlerBase
Throws:: org.xml.sax.SAXException

endElement
```
public void endElement(java.lang.String tagName)
                throws org.xml.sax.SAXException
```
Specified by:

endElement in interface org.xml.sax.DocumentHandler

Overrides:

endElement in class org.xml.sax.HandlerBase

Throws:

org.xml.sax.SAXException

characters
```
public void characters(char[] ch,
                       int offset,
                       int length)
```
Specified by:

characters in interface org.xml.sax.DocumentHandler

Overrides:

characters in class org.xml.sax.HandlerBase

Class SearchDescriptor

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class org.xml.sax.HandlerBase

Methods inherited from class java.lang.Object

Constructor Detail

SearchDescriptor

Method Detail

getScope

setScope

getBaseDN

setBaseDN

getFilter

setFilter

getReturnAttrs

listReturnAttrs

addReturnAttr

produce

startElement

endElement

characters