UserTypeInfo.java

package com.linkedin.databus.util;
/*
 *
 * Copyright 2013 LinkedIn Corp. All rights reserved
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 *
*/


import java.util.Collections;
import java.util.List;


/**
 * TypeInfo implementation for user-defined column types. A user type is typically comprised of a number of columns
 * of built-in types, basically like a table within a table. We see examples of this in member2, which has an education
 * history type with the name of the institution (VARCHAR2), dates attended (DATE), etc.  Alternatively, a user type
 * can be thought of as a generic table, with top-level database tables as a special case.
 * TODO:  sanitize comment for OSS (open source) release
 */
public class UserTypeInfo implements TypeInfo
{
  protected final String _ownerName;
  protected final String _name;
  protected final List<FieldInfo> _fields;

  public UserTypeInfo(String ownerName, String name, List<FieldInfo> fields)
  {
    _ownerName = ownerName;
    _name = name;
    _fields = Collections.unmodifiableList(fields);
  }

  /**
   * @return owner of the database type; typically the schema in which it was created
   */
  public String getOwnerName()
  {
    return _ownerName;
  }

  /**
   * @return name of this user type (like DATABUS_PROF_EDU_T)
   */
  public String getName()
  {
    return _name;
  }

  /**
   * @return info for all fields (columns) in this user-defined type
   */
  public List<FieldInfo> getFields()
  {
    return _fields;
  }

  /**
   * @return name of the primary-key field, if present
   */
  public String getPrimaryKey()
  {
    return null;
  }

  public String toString()
  {
    return "UserType: " + _name + "; Fields: " + _fields;
  }
}