| Home >> All >> org >> apache >> [ xmlbeans Javadoc ] |
| • | org.apache.xmlbeans.impl.* (285) | • | org.apache.xmlbeans.samples.* (56) | • | org.apache.xmlbeans.soap.* (2) |
| • | org.apache.xmlbeans.xml.* (24) |
• org.apache.xmlbeans: Javadoc index of package org.apache.xmlbeans.
Package Samples:
• org.apache.xmlbeans.samples.abstracttypes
• org.apache.xmlbeans.samples.any.impl
• org.apache.xmlbeans.samples.any
• org.apache.xmlbeans.samples.anytype
• org.apache.xmlbeans.samples.datetime
• org.apache.xmlbeans.samples.cursor
• org.apache.xmlbeans.samples.template
• org.apache.xmlbeans.samples.enumeration
• org.apache.xmlbeans.samples.substitutiongroup
• org.apache.xmlbeans.samples.validation.todolist.impl
• org.apache.xmlbeans.samples.validation.todolist
• org.apache.xmlbeans.samples.validation
• org.apache.xmlbeans.samples.xquery.employees.impl
• org.apache.xmlbeans.samples.xquery.employees
• org.apache.xmlbeans.samples.xquery
• org.apache.xmlbeans.samples.xmltree
• org.apache.xmlbeans.samples.xsdconfig
• org.apache.xmlbeans.samples.vxsdb
• org.apache.xmlbeans.impl.common
• org.apache.xmlbeans.impl.jam.internal.javadoc
Classes:
• RegularExpression: A regular expression matching engine using Non-deterministic Finite Automaton (NFA). This engine does not conform to the POSIX regular expression. How to use A. Standard way RegularExpression re = new RegularExpression( regex ); if (re.matches(text)) { ... } B. Capturing groups RegularExpression re = new RegularExpression( regex ); Match match = new Match(); if (re.matches(text, match)) { ... // You can refer captured texts with methods of the Match class. } Case-insensitive matching RegularExpression re = new RegularExpression( regex , "i"); if (re.matches(text) >= 0) { ...} Options You can specify ...
• SchemaType: Represents a schema type. SchemaType is the metadata "type" class for XmlObject , and it plays the analogous role for XmlObject that java.lang.Class plays for java.lang.Object . Every XML Bean class corresponds to a singleton SchemaType object obtainable by ClassName.type (e.g., XmlNonPositiveInteger.type 55 ), and every XML Bean instance has an actual SchemaType, obtainable by XmlObject.schemaType() 55 . The ClassName.type and schemaType() mechanisms are analogous to the ordinary Java ClassName.class and obj.getClass() mechanisms. All schema types are represented by a SchemaType, this includes ...
• SchemaTypeSystem: A finite set of XML Schema component definitions. Every SchemaComponent such as a SchemaType , SchemaGlobalElement , SchemaGlobalAttribute , SchemaModelGroup , SchemaAttributeGroup , or SchemaIdentityConstraint , is defined in exactly one SchemaTypeSystem. (See SchemaComponent.getTypeSystem() 55 .) A single SchemaTypeSystem can include definitions from any number of namespaces; one SchemaTypeSystem consists simply of a set of component definitions that were compiled together. Since every component is defined in a single SchemaTypeSystem, no SchemaTypeSystem other than XmlBeans.getBuiltinTypeSystem() ...
• XmlObject: Corresponds to the XML Schema xs:anyType , the base type for all XML Beans. Since all XML Schema types are translated into corresponding XML Bean classes, and all Schema type derivation corresponds to Java class inheritance, the fact that all Schema types derive from xs:anyType means that all XML Bean classes derive from XmlObject. On this base class you will find a number of common facilities that all XML Bean classes provide: Every XML Bean class has an inner Factory class for creating and parsing instances, including XmlObject. Use XmlObject.Factory itself to produce untyped XML trees or XML ...
• XmlCursor: Represents a position between two logical tokens in an XML document. The tokens themselves are not exposed as objects, but their type and properties are discoverable through methods on the cursor. In particular, the general category of token is represented by a TokenType . You use an XmlCursor instance to navigate through and manipulate an XML instance document. Once you obtain an XML document, you can create a cursor to represent a specific place in the XML. Because you can use a cursor with or without a schema corresponding to the XML, cursors are an ideal way to handle XML without a schema. ...
• ConcurrentReaderHashMap: A version of Hashtable that supports mostly-concurrent reading, but exclusive writing. Because reads are not limited to periods without writes, a concurrent reader policy is weaker than a classic reader/output policy, but is generally faster and allows more concurrency. This class is a good choice especially for tables that are mainly created by one thread during the start-up phase of a program, and from then on, are mainly read (with perhaps occasional additions or removals) in many threads. If you also need concurrency among writes, consider instead using ConcurrentHashMap. Successful retrievals ...
• AttachmentPart: A single attachment to a SOAPMessage object. A SOAPMessage object may contain zero, one, or many AttachmentPart objects. Each AttachmentPart object consists of two parts, application-specific content and associated MIME headers. The MIME headers consists of name/value pairs that can be used to identify and describe the content. An AttachmentPart object must conform to certain standards. It must conform to MIME [RFC2045] standards It MUST contain content The header portion MUST include the following header: Content-Type This header identifies the type of data in the content of an AttachmentPart ...
• SOAPEnvelope: The container for the SOAPHeader and SOAPBody portions of a SOAPPart object. By default, a SOAPMessage object is created with a SOAPPart object that has a SOAPEnvelope object. The SOAPEnvelope object by default has an empty SOAPBody object and an empty SOAPHeader object. The SOAPBody object is required, and the SOAPHeader object, though optional, is used in the majority of cases. If the SOAPHeader object is not needed, it can be deleted, which is shown later. A client can access the SOAPHeader and SOAPBody objects by calling the methods SOAPEnvelope.getHeader and SOAPEnvelope.getBody . The following ...
• XmlCalendar: An XML Schema compatible subclass of GregorianCalendar . XmlCalendar modifies several key details in the behavior of GregorianCalendar to make it more useful when dealing with XML dates. It is easy to convert between XmlCalendar and GDate , or to parse or emit an XmlCalendar using a standard XML Schema lexical representation. To match XML Schema dates, this XmlCalendar is a fully proleptic Gregorian calendar by default, which means that Gregorian calendar rules are applied backwards in time as if they had always been in effect, actual historical circumstances concerning the observance of the 1582 ...
• SchemaTypeLoader: Represents a searchable set of XML Schema component definitions. SchemaTypeLoader is somewhat analogous to java.lang.ClassLoader , because it is responsible for finding SchemaComponent definitions by name, yet it is not responsible for being able to enumerate all the component definitons available. (If you wish to enumerate component definitions, see SchemaTypeSystem .) There are some ways in which SchemaTypeSystems are dissimilar from ClassLoaders, however. Since XML Schema has a number of instance-oriented typing mechanisms (such as wildcards) that do not exist in Java, a SchemaTypeLoader is ...
• MessageFactory: A factory for creating SOAPMessage objects. A JAXM client performs the following steps to create a message. Creates a MessageFactory object from a ProviderConnection object ( con in the following line of code). The String passed to the createMessageFactory method is the name of of a messaging profile, which must be the URL for the schema. MessageFactory mf = con.createMessageFactory(schemaURL); Calls the method createMessage on the MessageFactory object. All messages produced by this MessageFactory object will have the header information appropriate for the messaging profile that was specified ...
• SOAPMessage: The root class for all SOAP messages. As transmitted on the "wire", a SOAP message is an XML document or a MIME message whose first body part is an XML/SOAP document. A SOAPMessage object consists of a SOAP part and optionally one or more attachment parts. The SOAP part for a SOAPMessage object is a SOAPPart object, which contains information used for message routing and identification, and which can contain application-specific content. All data in the SOAP Part of a message must be in XML format. A new SOAPMessage object contains the following by default: A SOAPPart object A SOAPEnvelope object ...
• XmlValidationError: The XmlValidationError class extends the XmlError XMLError class. The XML Validator contains extra attributes that can be used to construct the XML validation error programatically. To extract the validation error cast the errors to XmlValidationError instead of XmlError for example: xobj.validate(new XmlOptions().setErrorListener(errors)) for (Iterator it = errors.iterator(); it.hasNext(); ) { XmlError err = (XmlError)it.next()); if (err instanceof XmlValidationError) { XmlValidationError validationError = (XmlValidationError) err; } } Whenever an XmlValidationError is retrieved it will always ...
• XmlOptions: Used to supply options for loading, saving, and compiling, and validating. There are two styles for using XmlOptions: multiline setup, and single-line use. Here are two examples. First, multiline style: XmlOptions opts = new XmlOptions(); opts.setSavePrettyPrint(); opts.setSavePrettyPrintIndent(4); System.out.println(xobj.xmlText(opts)); The alternative is single-line usage: System.out.println(xobj.xmlText( new XmlOptions().setSavePrettyPrint().setSavePrettyPrintIndent(4))); Table showing where each option gets used. Note that: options available for newInstance methods will also apply for parse ...
• Name: A representation of an XML name. This interface provides methods for getting the local and namespace-qualified names and also for getting the prefix associated with the namespace for the name. It is also possible to get the URI of the namespace. The following is an example of a namespace declaration in an element. <wombat:GetLastTradePrice xmlns:wombat="http://www.wombat.org/trader"> ("xmlns" stands for "XML namespace".) The following shows what the methods in the Name interface will return. getQualifiedName will return "prefix:LocalName" = "WOMBAT:GetLastTradePrice" getURI will return "http://www.wombat.org/trader" ...
• QNameSet: This interface represents a lattice of finite and infinite sets of QNames. The lattice the minimal one that is closed under union, intersection, and inverse, and contains individual QNames as well as entire namespaces. Here is a summary of the two kinds of QNameSets: A QNameSet can cover a finite set of namespaces, additionally including a finite set of QNames outside those namespaces, and with the exception of a finite set of QNames excluded from those namespaes: excludedQNamesInIncludedURIs == the set of excluded QNames from coveredURIs namespaces excludedURIs == null includedURIs == the set ...
• SOAPPart: The container for the SOAP-specific portion of a SOAPMessage object. All messages are required to have a SOAP part, so when a SOAPMessage object is created, it will automatically have a SOAPPart object. A SOAPPart object is a MIME part and has the MIME headers Content-Id, Content-Location, and Content-Type. Because the value of Content-Type must be "text/xml", a SOAPPart object automatically has a MIME header of Content-Type with its value set to "text/xml". The value must be "text/xml" because content in the SOAP part of a message must be in XML format. Content that is not of type "text/xml" must ...
• SOAPHeader: A representation of the SOAP header element. A SOAP header element consists of XML data that affects the way the application-specific content is processed by the message provider. For example, transaction semantics, authentication information, and so on, can be specified as the content of a SOAPHeader object. A SOAPEnvelope object contains an empty SOAPHeader object by default. If the SOAPHeader object, which is optional, is not needed, it can be retrieved and deleted with the following line of code. The variable se is a SOAPEnvelope object. se.getHeader().detachNode(); A SOAPHeader object is created ...
• Detail: A container for DetailEntry objects. DetailEntry objects give detailed error information that is application-specific and related to the SOAPBody object that contains it. A Detail object, which is part of a SOAPFault object, can be retrieved using the method SOAPFault.getDetail . The Detail interface provides two methods. One creates a new DetailEntry object and also automatically adds it to the Detail object. The second method gets a list of the DetailEntry objects contained in a Detail object. The following code fragment, in which sf is a SOAPFault object, gets its Detail object ( d ), adds a ...
• XmlFactoryHook: A hook for the XML Bean Factory mechanism. Provided for advanced users who wish to provide their own implementation of the Factory.parse methods. This is used, for example, to defer reading XML streams until needed. To use the hook, call XmlFactoryHook.ThreadContext.setHook(), passing your own XmlFactoryHook implementation. Then every call to a Factory method will be delgated to your hook. MyHook hook = new MyHook(); XmlFactoryHook.ThreadContext.setHook(hook); // this results in a call to hook.parse(...) XmlObject.Factory.parse(new File("test.xml")); If the hook needs to turn around and invoke ...
• XmlToken: Corresponds to the XML Schema xs:token type. One of the derived types based on xs:string . A token is XML's best representation for a "whitespace insensitive string." All carriage returns, linefeeds, and tabs are converted to ordinary space characters (as with xs:normalizedString ), and furthermore, all contiguous runs of space are collapsed to single spaces, and leading and trailing spaces are trimmed. If you want " high priority " to be equivalent to "high priority" , you should consider using xs:token or a subtype of xs:token. When the XmlAnySimpleType.stringValue() ...
• SchemaParticle: Represents a Schema particle definition. The content model of a complex type is a tree of particles. Each particle is either an ALL 55 , CHOICE 55 , SEQUENCE 55 , ELEMENT 55 , or WILDCARD 55 . All, choice and sequence particles are groups that can have child particles; elements and wildcards are always leaves of the particle tree. The tree of particles available on a schema type is minimized, that is, it already has removed "pointless" particles such as empty sequences, nonrepeating sequences with only one item, and so on. ( Pointless particles are defined precisely in the XML Schema specification ...
• Validation: A sample to illustrate two means for validating XML against schema using features of the XMLBeans API. The features illustrated are: - Validating after changes by using the XmlObject.validate method. This method is exposed by types generated by compiling schema. The validate method validates instances against all aspects of schema. Also, with this method you can specify a Collection instance to capture errors that occur during validation. - Validating "on the fly" using the XmlOptions.VALIDATE_ON_SET constant. This option prompts XMLBeans to validate XML against simple schema types as you set them ...
• SOAPFault: An element in the SOAPBody object that contains error and/or status information. This information may relate to errors in the SOAPMessage object or to problems that are not related to the content in the message itself. Problems not related to the message itself are generally errors in processing, such as the inability to communicate with an upstream server. The SOAPFault interface provides methods for retrieving the information contained in a SOAPFault object and for setting the fault code, the fault actor, and a string describing the fault. A fault code is one of the codes defined in the SOAP ...
• XmlNormalizedString: Corresponds to the XML Schema xs:normalizedString type. One of the derived types based on xs:string . An normalizedString simply is a string where all the carriage return, linefeed, and tab characters have been normalized (switched to) ordinary space characters. Use normalizedString for long strings to make them insensitive to line breaking. If you wish to often be insensitive to runs of whitespace (as is often the case), use xs:token (aka XmlToken ) instead. Convertible to java.lang.String . When obtaining the stringValue, the whitespace-normalized value is returned.
| Home | Contact Us | Privacy Policy | Terms of Service |