/*
* Copyright (c) 2006-2011 Nuxeo SA (http://nuxeo.com/) and others.
*
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* Nuxeo - initial API and implementation
*
* $Id$
*/
package org.eclipse.ecr.core.schema.types;
import java.util.Collection;
import org.eclipse.ecr.core.schema.TypeRef;
/**
* A composite type is an aggregation of several schemas.
* <p>
* Each schema defines its own namespace to avoid
* field name collisions.
*
* @author <a href="mailto:bs@nuxeo.com">Bogdan Stefanescu</a>
*/
public interface CompositeType extends ComplexType {
/**
* Adds a schema.
*
* @param schema the schema name to add
*/
void addSchema(String schema);
/**
* Adds a schema.
*
* @param schema the schema to add
*/
void addSchema(Schema schema);
/**
* Gets the composite type schema given its name.
*
* @param name the schema name
* @return the schema if any or null if none was found
*/
Schema getSchema(String name);
/**
* Finds the composite type schema given the schema prefix.
*
* @param prefix the schema prefix
* @return the schema if any or null if none was found
*/
Schema getSchemaByPrefix(String prefix);
/**
* Checks if this composite type has any schema defined.
*
* @return true if this composite type has some schemas defined, false
* otherwise
*/
boolean hasSchemas();
/**
* Checks if this composite type has the given schema.
*
* @param name the schema name
* @return true if the composite type has this schema, false otherwise
*/
boolean hasSchema(String name);
/**
* Gets the schema names of this type.
*
* @return the schema names
*/
String[] getSchemaNames();
/**
* Gets all the schemas (including inherited schemas) of this composite type.
*
* @return the composite type schemas
*/
Collection<Schema> getSchemas();
@Override
TypeRef<? extends CompositeType> getRef();
}