com.aspose.words
Class CustomXmlSchemaCollection

java.lang.Object
    extended by com.aspose.words.CustomXmlSchemaCollection
All Implemented Interfaces:
java.lang.Iterable
public class CustomXmlSchemaCollection 
extends java.lang.Object

A collection of strings that represent XML schemas that are associated with a custom XML part.

To learn more, visit the Structured Document Tags or Content Control documentation article.

You do not create instances of this class. You access the collection of XML schemas of a custom XML part via the CustomXmlPart.Schemas property.

Example:

Shows how to work with an XML schema collection.
Document doc = new Document();

String xmlPartId = UUID.randomUUID().toString();
String xmlPartContent = "<root><text>Hello, World!</text></root>";
CustomXmlPart xmlPart = doc.getCustomXmlParts().add(xmlPartId, xmlPartContent);

// Add an XML schema association.
xmlPart.getSchemas().add("http://www.w3.org/2001/XMLSchema");

// Clone the custom XML part's XML schema association collection,
// and then add a couple of new schemas to the clone.
CustomXmlSchemaCollection schemas = xmlPart.getSchemas().deepClone();
schemas.add("http://www.w3.org/2001/XMLSchema-instance");
schemas.add("http://schemas.microsoft.com/office/2006/metadata/contentType");

Assert.assertEquals(3, schemas.getCount());
Assert.assertEquals(2, schemas.indexOf("http://schemas.microsoft.com/office/2006/metadata/contentType"));

// Enumerate the schemas and print each element.
Iterator<String> enumerator = schemas.iterator();
while (enumerator.hasNext()) {
    System.out.println(enumerator.next());
}

// Below are three ways of removing schemas from the collection.
// 1 -  Remove a schema by index:
schemas.removeAt(2);

// 2 -  Remove a schema by value:
schemas.remove("http://www.w3.org/2001/XMLSchema");

// 3 -  Use the "Clear" method to empty the collection at once.
schemas.clear();

Assert.assertEquals(schemas.getCount(), 0);
See Also:
CustomXmlPart, CustomXmlPart.Schemas

Property Getters/Setters Summary
intgetCount()
           Gets the number of elements contained in the collection.
java.lang.Stringget(int index)
voidset(int index, java.lang.String value)
           Gets or sets the element at the specified index.
 
Method Summary
voidadd(java.lang.String value)
           Adds an item to the collection.
voidclear()
           Removes all elements from the collection.
CustomXmlSchemaCollectiondeepClone()
           Makes a deep clone of this object.
intindexOf(java.lang.String value)
           Returns the zero-based index of the specified value in the collection.
java.util.Iterator<java.lang.String>iterator()
           Returns an iterator object that can be used to iterate over all items in the collection.
voidremove(java.lang.String name)
           Removes the specified value from the collection.
voidremoveAt(int index)
           Removes a value at the specified index.
 

Property Getters/Setters Detail

getCount

public int getCount()
Gets the number of elements contained in the collection.

Example:

Shows how to work with an XML schema collection.
Document doc = new Document();

String xmlPartId = UUID.randomUUID().toString();
String xmlPartContent = "<root><text>Hello, World!</text></root>";
CustomXmlPart xmlPart = doc.getCustomXmlParts().add(xmlPartId, xmlPartContent);

// Add an XML schema association.
xmlPart.getSchemas().add("http://www.w3.org/2001/XMLSchema");

// Clone the custom XML part's XML schema association collection,
// and then add a couple of new schemas to the clone.
CustomXmlSchemaCollection schemas = xmlPart.getSchemas().deepClone();
schemas.add("http://www.w3.org/2001/XMLSchema-instance");
schemas.add("http://schemas.microsoft.com/office/2006/metadata/contentType");

Assert.assertEquals(3, schemas.getCount());
Assert.assertEquals(2, schemas.indexOf("http://schemas.microsoft.com/office/2006/metadata/contentType"));

// Enumerate the schemas and print each element.
Iterator<String> enumerator = schemas.iterator();
while (enumerator.hasNext()) {
    System.out.println(enumerator.next());
}

// Below are three ways of removing schemas from the collection.
// 1 -  Remove a schema by index:
schemas.removeAt(2);

// 2 -  Remove a schema by value:
schemas.remove("http://www.w3.org/2001/XMLSchema");

// 3 -  Use the "Clear" method to empty the collection at once.
schemas.clear();

Assert.assertEquals(schemas.getCount(), 0);

get/set

public java.lang.String get(int index) / public void set(int index, java.lang.String value)
Gets or sets the element at the specified index.

Example:

Shows how to work with an XML schema collection.
Document doc = new Document();

String xmlPartId = UUID.randomUUID().toString();
String xmlPartContent = "<root><text>Hello, World!</text></root>";
CustomXmlPart xmlPart = doc.getCustomXmlParts().add(xmlPartId, xmlPartContent);

// Add an XML schema association.
xmlPart.getSchemas().add("http://www.w3.org/2001/XMLSchema");

// Clone the custom XML part's XML schema association collection,
// and then add a couple of new schemas to the clone.
CustomXmlSchemaCollection schemas = xmlPart.getSchemas().deepClone();
schemas.add("http://www.w3.org/2001/XMLSchema-instance");
schemas.add("http://schemas.microsoft.com/office/2006/metadata/contentType");

Assert.assertEquals(3, schemas.getCount());
Assert.assertEquals(2, schemas.indexOf("http://schemas.microsoft.com/office/2006/metadata/contentType"));

// Enumerate the schemas and print each element.
Iterator<String> enumerator = schemas.iterator();
while (enumerator.hasNext()) {
    System.out.println(enumerator.next());
}

// Below are three ways of removing schemas from the collection.
// 1 -  Remove a schema by index:
schemas.removeAt(2);

// 2 -  Remove a schema by value:
schemas.remove("http://www.w3.org/2001/XMLSchema");

// 3 -  Use the "Clear" method to empty the collection at once.
schemas.clear();

Assert.assertEquals(schemas.getCount(), 0);
Method Detail

add

public void add(java.lang.String value)
Adds an item to the collection.
Parameters:
value - The item to add.

Example:

Shows how to work with an XML schema collection.
Document doc = new Document();

String xmlPartId = UUID.randomUUID().toString();
String xmlPartContent = "<root><text>Hello, World!</text></root>";
CustomXmlPart xmlPart = doc.getCustomXmlParts().add(xmlPartId, xmlPartContent);

// Add an XML schema association.
xmlPart.getSchemas().add("http://www.w3.org/2001/XMLSchema");

// Clone the custom XML part's XML schema association collection,
// and then add a couple of new schemas to the clone.
CustomXmlSchemaCollection schemas = xmlPart.getSchemas().deepClone();
schemas.add("http://www.w3.org/2001/XMLSchema-instance");
schemas.add("http://schemas.microsoft.com/office/2006/metadata/contentType");

Assert.assertEquals(3, schemas.getCount());
Assert.assertEquals(2, schemas.indexOf("http://schemas.microsoft.com/office/2006/metadata/contentType"));

// Enumerate the schemas and print each element.
Iterator<String> enumerator = schemas.iterator();
while (enumerator.hasNext()) {
    System.out.println(enumerator.next());
}

// Below are three ways of removing schemas from the collection.
// 1 -  Remove a schema by index:
schemas.removeAt(2);

// 2 -  Remove a schema by value:
schemas.remove("http://www.w3.org/2001/XMLSchema");

// 3 -  Use the "Clear" method to empty the collection at once.
schemas.clear();

Assert.assertEquals(schemas.getCount(), 0);

clear

public void clear()
Removes all elements from the collection.

Example:

Shows how to work with an XML schema collection.
Document doc = new Document();

String xmlPartId = UUID.randomUUID().toString();
String xmlPartContent = "<root><text>Hello, World!</text></root>";
CustomXmlPart xmlPart = doc.getCustomXmlParts().add(xmlPartId, xmlPartContent);

// Add an XML schema association.
xmlPart.getSchemas().add("http://www.w3.org/2001/XMLSchema");

// Clone the custom XML part's XML schema association collection,
// and then add a couple of new schemas to the clone.
CustomXmlSchemaCollection schemas = xmlPart.getSchemas().deepClone();
schemas.add("http://www.w3.org/2001/XMLSchema-instance");
schemas.add("http://schemas.microsoft.com/office/2006/metadata/contentType");

Assert.assertEquals(3, schemas.getCount());
Assert.assertEquals(2, schemas.indexOf("http://schemas.microsoft.com/office/2006/metadata/contentType"));

// Enumerate the schemas and print each element.
Iterator<String> enumerator = schemas.iterator();
while (enumerator.hasNext()) {
    System.out.println(enumerator.next());
}

// Below are three ways of removing schemas from the collection.
// 1 -  Remove a schema by index:
schemas.removeAt(2);

// 2 -  Remove a schema by value:
schemas.remove("http://www.w3.org/2001/XMLSchema");

// 3 -  Use the "Clear" method to empty the collection at once.
schemas.clear();

Assert.assertEquals(schemas.getCount(), 0);

deepClone

public CustomXmlSchemaCollection deepClone()
Makes a deep clone of this object.

Example:

Shows how to work with an XML schema collection.
Document doc = new Document();

String xmlPartId = UUID.randomUUID().toString();
String xmlPartContent = "<root><text>Hello, World!</text></root>";
CustomXmlPart xmlPart = doc.getCustomXmlParts().add(xmlPartId, xmlPartContent);

// Add an XML schema association.
xmlPart.getSchemas().add("http://www.w3.org/2001/XMLSchema");

// Clone the custom XML part's XML schema association collection,
// and then add a couple of new schemas to the clone.
CustomXmlSchemaCollection schemas = xmlPart.getSchemas().deepClone();
schemas.add("http://www.w3.org/2001/XMLSchema-instance");
schemas.add("http://schemas.microsoft.com/office/2006/metadata/contentType");

Assert.assertEquals(3, schemas.getCount());
Assert.assertEquals(2, schemas.indexOf("http://schemas.microsoft.com/office/2006/metadata/contentType"));

// Enumerate the schemas and print each element.
Iterator<String> enumerator = schemas.iterator();
while (enumerator.hasNext()) {
    System.out.println(enumerator.next());
}

// Below are three ways of removing schemas from the collection.
// 1 -  Remove a schema by index:
schemas.removeAt(2);

// 2 -  Remove a schema by value:
schemas.remove("http://www.w3.org/2001/XMLSchema");

// 3 -  Use the "Clear" method to empty the collection at once.
schemas.clear();

Assert.assertEquals(schemas.getCount(), 0);

indexOf

public int indexOf(java.lang.String value)
Returns the zero-based index of the specified value in the collection.
Parameters:
value - The case-sensitive value to locate.
Returns:
The zero based index. Negative value if not found.

Example:

Shows how to work with an XML schema collection.
Document doc = new Document();

String xmlPartId = UUID.randomUUID().toString();
String xmlPartContent = "<root><text>Hello, World!</text></root>";
CustomXmlPart xmlPart = doc.getCustomXmlParts().add(xmlPartId, xmlPartContent);

// Add an XML schema association.
xmlPart.getSchemas().add("http://www.w3.org/2001/XMLSchema");

// Clone the custom XML part's XML schema association collection,
// and then add a couple of new schemas to the clone.
CustomXmlSchemaCollection schemas = xmlPart.getSchemas().deepClone();
schemas.add("http://www.w3.org/2001/XMLSchema-instance");
schemas.add("http://schemas.microsoft.com/office/2006/metadata/contentType");

Assert.assertEquals(3, schemas.getCount());
Assert.assertEquals(2, schemas.indexOf("http://schemas.microsoft.com/office/2006/metadata/contentType"));

// Enumerate the schemas and print each element.
Iterator<String> enumerator = schemas.iterator();
while (enumerator.hasNext()) {
    System.out.println(enumerator.next());
}

// Below are three ways of removing schemas from the collection.
// 1 -  Remove a schema by index:
schemas.removeAt(2);

// 2 -  Remove a schema by value:
schemas.remove("http://www.w3.org/2001/XMLSchema");

// 3 -  Use the "Clear" method to empty the collection at once.
schemas.clear();

Assert.assertEquals(schemas.getCount(), 0);

iterator

public java.util.Iterator<java.lang.String> iterator()
Returns an iterator object that can be used to iterate over all items in the collection.

Example:

Shows how to work with an XML schema collection.
Document doc = new Document();

String xmlPartId = UUID.randomUUID().toString();
String xmlPartContent = "<root><text>Hello, World!</text></root>";
CustomXmlPart xmlPart = doc.getCustomXmlParts().add(xmlPartId, xmlPartContent);

// Add an XML schema association.
xmlPart.getSchemas().add("http://www.w3.org/2001/XMLSchema");

// Clone the custom XML part's XML schema association collection,
// and then add a couple of new schemas to the clone.
CustomXmlSchemaCollection schemas = xmlPart.getSchemas().deepClone();
schemas.add("http://www.w3.org/2001/XMLSchema-instance");
schemas.add("http://schemas.microsoft.com/office/2006/metadata/contentType");

Assert.assertEquals(3, schemas.getCount());
Assert.assertEquals(2, schemas.indexOf("http://schemas.microsoft.com/office/2006/metadata/contentType"));

// Enumerate the schemas and print each element.
Iterator<String> enumerator = schemas.iterator();
while (enumerator.hasNext()) {
    System.out.println(enumerator.next());
}

// Below are three ways of removing schemas from the collection.
// 1 -  Remove a schema by index:
schemas.removeAt(2);

// 2 -  Remove a schema by value:
schemas.remove("http://www.w3.org/2001/XMLSchema");

// 3 -  Use the "Clear" method to empty the collection at once.
schemas.clear();

Assert.assertEquals(schemas.getCount(), 0);

remove

public void remove(java.lang.String name)
Removes the specified value from the collection.
Parameters:
name - The case-sensitive value to remove.

Example:

Shows how to work with an XML schema collection.
Document doc = new Document();

String xmlPartId = UUID.randomUUID().toString();
String xmlPartContent = "<root><text>Hello, World!</text></root>";
CustomXmlPart xmlPart = doc.getCustomXmlParts().add(xmlPartId, xmlPartContent);

// Add an XML schema association.
xmlPart.getSchemas().add("http://www.w3.org/2001/XMLSchema");

// Clone the custom XML part's XML schema association collection,
// and then add a couple of new schemas to the clone.
CustomXmlSchemaCollection schemas = xmlPart.getSchemas().deepClone();
schemas.add("http://www.w3.org/2001/XMLSchema-instance");
schemas.add("http://schemas.microsoft.com/office/2006/metadata/contentType");

Assert.assertEquals(3, schemas.getCount());
Assert.assertEquals(2, schemas.indexOf("http://schemas.microsoft.com/office/2006/metadata/contentType"));

// Enumerate the schemas and print each element.
Iterator<String> enumerator = schemas.iterator();
while (enumerator.hasNext()) {
    System.out.println(enumerator.next());
}

// Below are three ways of removing schemas from the collection.
// 1 -  Remove a schema by index:
schemas.removeAt(2);

// 2 -  Remove a schema by value:
schemas.remove("http://www.w3.org/2001/XMLSchema");

// 3 -  Use the "Clear" method to empty the collection at once.
schemas.clear();

Assert.assertEquals(schemas.getCount(), 0);

removeAt

public void removeAt(int index)
Removes a value at the specified index.
Parameters:
index - The zero based index.

Example:

Shows how to work with an XML schema collection.
Document doc = new Document();

String xmlPartId = UUID.randomUUID().toString();
String xmlPartContent = "<root><text>Hello, World!</text></root>";
CustomXmlPart xmlPart = doc.getCustomXmlParts().add(xmlPartId, xmlPartContent);

// Add an XML schema association.
xmlPart.getSchemas().add("http://www.w3.org/2001/XMLSchema");

// Clone the custom XML part's XML schema association collection,
// and then add a couple of new schemas to the clone.
CustomXmlSchemaCollection schemas = xmlPart.getSchemas().deepClone();
schemas.add("http://www.w3.org/2001/XMLSchema-instance");
schemas.add("http://schemas.microsoft.com/office/2006/metadata/contentType");

Assert.assertEquals(3, schemas.getCount());
Assert.assertEquals(2, schemas.indexOf("http://schemas.microsoft.com/office/2006/metadata/contentType"));

// Enumerate the schemas and print each element.
Iterator<String> enumerator = schemas.iterator();
while (enumerator.hasNext()) {
    System.out.println(enumerator.next());
}

// Below are three ways of removing schemas from the collection.
// 1 -  Remove a schema by index:
schemas.removeAt(2);

// 2 -  Remove a schema by value:
schemas.remove("http://www.w3.org/2001/XMLSchema");

// 3 -  Use the "Clear" method to empty the collection at once.
schemas.clear();

Assert.assertEquals(schemas.getCount(), 0);
See Also:
          Aspose.Words Documentation - the home page for the Aspose.Words Product Documentation.
          Aspose.Words Support Forum - our preferred method of support.

We guarantee a prompt response to any inquiry!

© 2003-2007 Aspose Pty Ltd. All rights reserved.