ListType.java

/*
 * @(#)$Id: ListType.java,v 1.27 2002/06/24 19:57:28 kk122374 Exp $
 *
 * Copyright 2001 Sun Microsystems, Inc. All Rights Reserved.
 * 
 * This software is the proprietary information of Sun Microsystems, Inc.  
 * Use is subject to license terms.
 * 
 */
package com.sun.msv.datatype.xsd;

import java.util.StringTokenizer;
import com.sun.msv.datatype.SerializationContext;
import org.relaxng.datatype.DatatypeException;
import org.relaxng.datatype.ValidationContext;

/**
 * List type.
 * 
 * type of the value object is {@link ListValueType}.
 * 
 * @author <a href="mailto:kohsuke.kawaguchi@eng.sun.com">Kohsuke KAWAGUCHI</a>
 */
public final class ListType extends ConcreteType implements Discrete {
	
	/**
	 * derives a new datatype from atomic datatype by list
	 */
	public ListType( String nsUri, String newTypeName, XSDatatypeImpl itemType ) throws DatatypeException {
		super(nsUri,newTypeName);
		
		if(itemType.isFinal( DERIVATION_BY_LIST ))
			// derivation by list is not applicable
			throw new DatatypeException( localize(ERR_INVALID_ITEMTYPE) );
		
		this.itemType = itemType;
	}
	
	/** atomic base type */
	final public XSDatatypeImpl itemType;

	
	public final String displayName() {
		String name = getName();
        if(name!=null)      return name;
        else                return itemType.displayName()+"-list";
	}
    
	/**
	 * Variety of the ListType is VARIETY_LIST. So this method always
	 * returns VARIETY_LIST.
	 */
	public final int getVariety() {
		return VARIETY_LIST;
	}
    
	final public XSDatatype getBaseType() {
		return SimpleURType.theInstance;
	}
	
	/**
	 * The list type is context-dependent if its item type is so.
	 */
	public boolean isContextDependent() {
		return itemType.isContextDependent();
	}

	public int getIdType() {
		switch(itemType.getIdType()) {
		case ID_TYPE_NULL:		return ID_TYPE_NULL;
		/* we don't support list of IDs.
			The spec of XML Schema Part 1 doesn't seem to support the list of IDs.
			It's probably the corner case of the spec, I guess.
		*/
		case ID_TYPE_ID:		return ID_TYPE_NULL;
		case ID_TYPE_IDREF:		return ID_TYPE_IDREFS;
		case ID_TYPE_IDREFS:	return ID_TYPE_IDREFS;
		default:				throw new Error();		// undefined code.
		}
	}
	
	public final boolean isFinal( int derivationType ) {
		// cannot derive by list from list.
		if(derivationType==DERIVATION_BY_LIST)	return true;
		return itemType.isFinal(derivationType);
	}
	
	public final int isFacetApplicable( String facetName ) {
		if( facetName.equals(FACET_LENGTH)
		||	facetName.equals(FACET_MINLENGTH)
		||	facetName.equals(FACET_MAXLENGTH)
		||	facetName.equals(FACET_ENUMERATION)
        ||  facetName.equals(FACET_PATTERN))
			return APPLICABLE;
		else
			return NOT_ALLOWED;
	}
	
	protected final boolean checkFormat( String content, ValidationContext context ) {
		// Are #x9, #xD, and #xA allowed as a separator, or not?
		StringTokenizer tokens = new StringTokenizer(content);
		
		while( tokens.hasMoreTokens() )
			if(!itemType.isValid(tokens.nextToken(),context))	return false;
		
		return true;
	}
	
	public Object _createValue( String content, ValidationContext context ) {
		// StringTokenizer correctly implements the semantics of whiteSpace="collapse"
		StringTokenizer tokens = new StringTokenizer(content);
		
		Object[] values = new Object[tokens.countTokens()];
		int i=0;
		
		while( tokens.hasMoreTokens() ) {
			if( ( values[i++] = itemType._createValue(tokens.nextToken(),context) )==null )
				return null;
		}
			
		return new ListValueType(values);
	}
	public Class getJavaObjectType() {
		return Object[].class;
	}
	
	public final int countLength( Object value ) {
		// for list type, length is a number of items.
		return ((ListValueType)value).values.length;
	}
	
	public String convertToLexicalValue( Object value, SerializationContext context ) {
		if(!(value instanceof ListValueType))
			throw new IllegalArgumentException();
		
		ListValueType lv = (ListValueType)value;
	
		StringBuffer r = new StringBuffer();
		for( int i=0; i<lv.values.length; i++ ) {
			if(i!=0)	r.append(' ');
			r.append( itemType.convertToLexicalValue(lv.values[i],context) );
		}
		return r.toString();
	}
	
	/** The current implementation detects which list item is considered wrong. */
	protected void _checkValid(String content, ValidationContext context) throws DatatypeException {
		// StringTokenizer correctly implements the semantics of whiteSpace="collapse"
		StringTokenizer tokens = new StringTokenizer(content);
		
		while( tokens.hasMoreTokens() ) {
			String token = tokens.nextToken();
			itemType.checkValid(token,context);
		}
	}

}